Public API Tokens

Public API Tokens are short alpha-numeric strings used to idenfity the account requesting data through our web services. Tokens are different from API Keys.

How do I use my tokens?

Whenever you ask for data from one of our services, you will give us your token to identify youtself either as a URL parameter or part of the URL path itself. Use only one token per request, and consult the documentation for the data service you are using to know how best to include the token.

Here are some examples of how a token may be included in a data request:

You should .not. use a new token for every API request

How do I manage my tokens?

If you wish to create, view, or disable your API tokens, you have two options:

When should I use multiple tokens?

You are always free to have multiple tokens, but there is never a requirement to use them. Tokens are a way of separating and controlling your own API usage. If you are using your Synoptic data access individually, or purely internally for processes, it is likely not necessary for you to use multiple tokens.

However, if your use of our data services may be accessible to others, such as on a webpage your customers visit, you may want to use multiple tokens to isolate each application or user, and give you more control over your API usage.

Token appearance

Tokens consist of different characters, and are a different length from API keys. Tokens you generate from your developer account (either with your API key or in your control panel) will be 32 characters long, with ony hexidecimal characters (0-9 and a-f). A key, alternatively will use a much more diverse array of letters as well as numbers.

Here is an example token


Details about tokens