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.
- OAuth2. This should only be used when your integration with Spark API specifically requires the use of OAuth2. Otherwise, use OpenID Connect.
- Spark API authentication. This method has been deprecated and is not recommended for new keys. This is used when writing IDX products that act on behalf of a single user explicitly defined for that key.
If there are questions on the API key's configuration, please contact firstname.lastname@example.org or submit a Jira ticket.
More information about API key roles may be found here.