image for site

Authentication Methods for Sunshine Conversations APIs

Learn about Basic authentication and JWTs for Sunshine Conversations APIs, both requiring an API key for secure access.

What are the authentication methods for Sunshine Conversations APIs?

To authenticate requests using Sunshine Conversations APIs, you can use either Basic authentication or JSON Web Tokens (JWTs). Both methods require an API key. Basic authentication involves using the API key directly, where the Key ID acts as the username and the secret key as the password. For JWTs, you sign tokens with an API key, and the Key ID is included in the JWT header as the 'kid' property, while the secret signs the JWT.

It's important to note that API keys are not as secure as authentication tokens, so it's crucial to follow best practices for securely handling credentials in production. For more details, you can refer to theAPI Authenticationsection.


More related questions

How do I create and share an API key for Conversations API?

Creating and sharing an API key for the Conversations API involves a few steps. First, a Zendesk administrator must create the API key and share it with the developer. You can store up to 10 keys at a time. To create an API key, go to the Admin…

What is the difference between the Conversations API key and the Integrating Conversations API key?

The Conversations API key is intended for app-level authentication, while the Integrating Conversations API key is specific to a conversation integration. This distinction is important because the Conversations API key is used for server-to-server…

What are the requirements to access the Conversations API page?

To access the Conversations API page, you need to be on a Zendesk Suite Professional plan or above, and the Zendesk Agent Workspace must be activated. This access is necessary to create and manage API keys for Sunshine Conversations. If you require…

How can I delete an unused API key in Zendesk?

Deleting an unused API key in Zendesk is straightforward. Navigate to the Admin Center, click on 'Apps and integrations' in the sidebar, then select 'APIs > Conversations API'. Hover over the key you wish to delete, click the options menu, and…

Why can't I see the Conversations API option in Zendesk?

If you can't see the Conversations API option in Zendesk, it might be because you don't have a Sunshine Conversations account. The Conversations API is available only if you have this account. If you need assistance connecting it to your Zendesk…

Interested indeflectingover 70% of your Zendesk support tickets?

Our AI customer support agent is here to help. Trained on all your help docs, installed directly into your Zendesk account, it can be used to automate customer replies for tickets or live chat. Learn more below.
Zendesk logo

Zendesk Support Tickets

Receive new tickets by email or a support form? This integration is for you.
My AskAI integrated within Zendesk to deflect support tickets
Learn about our Zendesk ticket integration
Zendesk logo

Zendesk Messaging (live chat)

Using Zendesk's Messaging widget on your site for live chat? This integration is for you.
My AskAI integrated within Zendesk to deflect customer support live chat conversations
Learn about our Zendesk Messaging integration

Join1,000+ companies reducing their support costs and freeing up support agents for more important work

Vestd company logo — Customer of My AskAI's AI customer support agents
Genesis company logo — Customer of My AskAI's AI customer support agents
Zinc company logo — Customer of My AskAI's AI customer support agents
Customer.io company logo — Customer of My AskAI's AI customer support agents
Zeffy company logo — Customer of My AskAI's AI customer support agents
NHS company logo — Customer of My AskAI's AI customer support agents
Kontakt.io company logo — Customer of My AskAI's AI customer support agents

Reduce support costs.Spend more time on customer success.

Our AI customer support agents are already used by 👇
Companies using AI assistants on their websites