Authentication
Authentication for JigsawStack API
Base URL
The JigsawStack base URL is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The base URL does not support HTTP.
Base URL
https://api.jigsawstack.com
The JigsawStack API uses API keys to authenticate requests. You can view and manage your API keys in the JigsawStack dashboard.
Authenticated request
Attach the header parameter x-api-key
with the API key obtained from your dashboard.
To retrieve your API key
- Log in to your JigsawStack dashboard
- Navigate to Keys tab.
- Click on
Create new key
button to create a new api key. - Copy the api key and use it in your requests.
Public and Secret API keys
The JigsawStack API has two types of API keys: public
and secret
.
- Public API keys are great for frontend applications and APIs required to be called on the front end. Requires API restriction to be set.
Domain whitelisting is recommended when creating
public
api keys.- Secret API keys are great for backend services. Has access to all APIs.
Your secret
API key should never be public, shared or exposed in a github
repository.
Was this page helpful?