| Info |
|---|
Note: this feature is only available to customers with API |
...
access enabled. To learn more, please reach out to support@goeverbright.com |
API credentials are unique identifiers that our system uses to connect
...
a customer’s EverBright account with other
...
software tools via APIs to automate
...
workflows and
...
increase data accuracy across platforms.
How do I see the credentials associated with my account?
First, navigate to Settings and select
...
Integration Settings on the left sidebar.The Credentials and Webhooks tab is the second tab on this page.
...
Above is an example of an account with no credentials set up.
How do I add credentials to my account?
1. To add a credential, click the green Add Credential button
...
...
2. From there, an Add Credentials modal will open.
...
3. Name your credential: this should be something simple that identifies the integration.
4. Base URL: This is the address of the API endpoint. You are required to enter a URL path when setting up a webhook, so this should be the primary / re-used component of the URL.
5. Determine some settings for your API Credential:
Test credentials - toggle: If this is toggled on, you will see a “test” label next to the credential name. And the credentials will only be used on
...
EverBright testing environments like Onboard. If it is toggled off, it will be used on our production environment, Engine.
Org. Specific Authentication - toggle: if this is turned on, you will be able to add API keys for multiple organizations in the same credential.
...
Ex: If you have this toggled on, then you can add API keys for more than one organization. As you can see above, you can continue to add organizations by clicking the Add Organization Credential button. You can remove an organization’s credentials, by clicking the Remove Organization button to the right of the dropdown.
This is rarely used by installer partners.
6. Add Headers:
The Content-Type header is required. You can choose JSON, XML, or form-urlencoded
...
. JSON is the most common selection
You can also add additional optional headers by clicking the + Header button
...
...
You can also remove the additional header by clicking the “X” to the right of the header.
Note: If you want to use Headers for authentication, select Headers in the Authentication Data section, explained below.
7. Select the Authentication type:
No Authentication - You do not need to provide any information in addition to the header(s).
Headers - You will be asked to provide a secret Key and a Value that your server will recognize.
Basic - With this method, you provide a username and password that will be supplied to your server in HTTP basic auth format.
Token (Bearer Auth) - This authentication method works by ensuring that each request to a server is accompanied by a signed token which the server verifies for authenticity and only then responds to the request. You will be asked to provide a Key and a Value.
AWS4 - You will be asked to provide an Access Key, a Secret Key, AWS Region, AWS Service, and a Base Endpoint.
HMAC-SHA256 - You will be asked to provide a Client ID and a Client Secret.
...
