When making requests using Sunshine Conversations APIs, authentication is required to verify the caller's identity. You can use eitherBasic authenticationorJSON Web Tokens (JWTs)to verify a caller's identity. Both methods require an API key. You create the API key using the Conversations API page.
Access to the Conversations API page is included in theZendesk Suite Professional plans or above. You must have the Zendesk Agent Workspaceactivatedto see the page. Additional add-on packs are available if you require more Monthly Active Users (MAU) or notifications. For more information, seeAbout Zendesk Suite add-ons.
This article includes these sections:
About API keys
An API key identifies and authenticates an application or user and is composed of three pieces:
- TheApp IDidentifies your Zendesk account.
- TheKey IDwhen used together with the secret key are the credentials used to authenticate JWTs and API calls.
- Thesecret keyis the authentication password.
With Basic authentication, you make requests using an API key directly. The key ID is the username and the secret is the password.
With JWTs, you sign tokens with an API key, which are then used to authenticate with the API. The key ID is included in the JWT header as thekidproperty, while the secret signs the JWT.
API keys are not as secure as authentication tokens. Be sure to follow good practices tosecurely handle credentialswhen using an API key in production.
For more information on Sunshine Conversations authentication, seeAPI Authentication.
The Sunshine Conversations API key is different frommessaging authentication keys. Messaging authentication keys are used to sign credentials that authenticate end users using Zendesk SDKs. The API key here is for server-to-server calls and provides access toSunshine Conversations public APIsthat support theappscope.
Creating and sharing the IDs and API key
A Zendesk administrator must create an API key and share it with the developer. You can store up to 10 keys.
To create and share an API key
- InAdmin Center, click
Apps and integrationsin the sidebar, then selectAPIs > Conversations API.
Note:You must have aZendesk Suite Professional plan or aboveto view this window. - ClickCreate API key.
If you are creating your first key, this button appears at the bottom of the page; if you have previously created a key, it appears in the top-right corner.
- Enter an identifying name for the key in the Create new key dialog, then clickNext.
- In the Copy shared secret dialog, clickCopyfor each ID and secret key to save it to your clipboard, then clickNext.
You're returned to the API window, where the new key appears in the list.
If you generate a new key but have reached your 10-key limit, a notification appears, asking you to delete any unused keys.
To delete an unused key
- InAdmin Center, clickApps and integrationsin the sidebar, then selectAPIs > Conversations API.
- Hover your mouse pointer over the key you want to delete, then click the options menu (
) and select删除. - Confirm the action by clicking删除.
2 Comments
Hi Gary,
You wrote:
However, I do not see "Conversations API" under APIs (only "Zendesk API").
How can I create an API key for Conversations?
Conversations API is available if you have aSunshine Conversationsaccount. If you don't have a Sunshine Conversations account yet or need assistance to connect it to your Zendesk Suite account please contact your sales representative for further assistance. You can also talk to our Sales teamhere.
Pleasesign into leave a comment.