Authentication Overview

There are several methods of authenticating and establishing a session with the Spark® API. The appropriate method depends on how the developer's API key is configured and the needs of the application:

OpenID Connect. This is the preferred approach. OpenID Connect combines identity and API authorization in one simple request.
Access Token. This is used when writing products that act on behalf of a single user explicitly defined for that key.

Already have an API Key?

Find out which documentation matches your key by entering it here:

Please review the OpenID Connect documentation

Please review the Spark API authentication documentation

Please review the Single Session documentation

No key found. Please check your entry, or contact api-support@sparkplatform.com

If there are questions on the API key's configuration, please contact api-support@sparkplatform.com or submit a Jira ticket.

More information about API key roles may be found here.