Authentication

Create API key

API keys are required as an authentication method with Syncblock products. Authentication through an API key is essential to grant access to the specific method. Access to the API is not possible without proper authentication.

You can generate and manage API keys from within the Syncblock Dashboard here. By clicking on "Create new API key" you can enter a name and the system will generate a unique for your user key for API authentication. Multiple keys can be generated. Old API keys, that you no longer want to use, can be disabled from the same location.

Use API key

API keys are required for the authentication of the calling program to the API. They can be used in test environments such as: Development, QA, and main Production environments.

We do not recommend using the same API key for more than one environment. We do recommend using a single key for one specific environment - Testing, Production, etc. The API key is sensitive private information that we strongly advise to have and keep restricted access to it.

Content-Type: application/json X-API-Key: my-api-key

API Credential Usage - Credits

Data Limiting

Data limiting is essential for the user's experience with our APIs. The purpose of data limiting is to prevent overload of the APIs, to optimize processing and response speed, and to enhance the overall security of Syncblock services. The extent to which data limiting varies is based on your subscription tier: different services offer varying levels of data flow limiting. For more information on Syncblock products, please visit our pricing page.