API Developer Documentation Glossary

Follow

A

account: In code accountName. Refers to the accountName, clientId, clientSecret combination and any other configuration associated with this combination. Discussed in detail in the authentication and authorization overview. Collectively, sometimes referred to as the API "key."

access token: in HTTP headers, accessToken, in text sometimes just "token". Discussed in detail in the authentication and authorization overview.

C

client ID: In code clientId. A randomly generated, but not secret, ID that is associated with the account. An account is often referred to by its account name, which is a more human-friendly identifier, but in code, the account is referred to by the client ID.

client secret: in code clientSecret. A randomly generated, secret string that is associated with the client ID. Discussed in the authentication and authorization overview.

I

ID: In code, id, companyId or contactId, depending on context. In text, ID may refer to a company id, or a contact id, and when this is not obvious from context, which it refers to is specified.

K

key: Refers to the combination of clientId and clientSecret. The latter terminology is motivated by OAuth 2.0 terminology. "Account" and "key" are used interchangeably in the knowledge base documentation.

T

throttling time period: A sliding window of time over which counts of requests for a token are accumulated. Discussed in the throttling and quota monitoring overview.

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk