Builder Credentials

The Builder Credentials tab allows System Builders to create credentials solely for testing APIs during the system creation process for each system version. It appears next to the System Details tab on the System Overview page and lists all added credentials. Builders can Add, Edit, Delete or Test credentials as needed.

Adding a Credential

When you click “Add Credential,” a pop-up appears where you can enter test credential details. The form fields change depending on the selected authentication type (e.g., Basic, OAuth1, OAuth2, Token, etc.).

Credential Fields (Basic Auth Example)

  • Credential Name (required): A unique and recognizable name for the credential.

  • Timezone: Select the timezone relevant to the credential (affects time-based API testing).

  • Username (required): Username for authentication.

  • Password (required): Password for authentication (eye icon available to toggle visibility).

Field options adjust automatically based on the selected authentication type. Any fields added under the Credential Inputs section will also appear when adding or editing a credential.

Testing and Saving

Click “Test and Save” to validate the credential. Only valid credentials will be saved. If Test Connection fails due to invalid credentials, the save will be blocked and an error log will appear.

Testing Existing Credentials

Use the “Test Connection” button to verify if an added credential is working properly with the system.

Important Notes

  • Only one builder credential per authentication type is allowed per system version.

  • Each credential is tied to a specific version of the system (including drafts).

  • Only one authentication type is supported per system in the initial release.

  • This tab is visible only to System Builders - end users cannot access it.

  • This feature is meant for building systems and testing APIs before use.

Last updated

Was this helpful?