Synapses API uses API keys to authenticate requests. These API keys can be generated from or for development purposes and must be supplied with each request.

Generating API Key

  1. Click on the Setting -> API Token or directly visit <dashboard>/developer/token

  2. Click “Generate

Using API Key

An API key is a token that a client provides when making API calls. Synapses API provides two methods for authentication.

  1. As a query string parameter





    "key": "YOUR_API_KEY"




  2. In the authorization header "Authorization: Bearer YOUR_API_KEY"

Both of the methods above work with Synapses API. The query string is easier to implement. But, makes it easier to discover for someone who should not have access to it. For every API call, we recommend using an authorization header since it is more secure.

Last updated