Authentication
This guide provides developers with step-by-step instructions for authenticating API requests to the JobsEQ API using an API Key. Authentication is mandatory for accessing any JobsEQ API endpoints.
Overview
JobsEQ uses API Key-based authentication via the HTTP Authorization header. All authenticated requests must include this header with the prefix EQ-Key, followed by your unique API key.
Format
The required format for the Authorization header is:
Authorization: EQ-Key <your-api-key>
Notes
EQ-Key
is case sensitive.- Replace <your-api-key> with the actual API key provided to you.
Example
Let’s say your API key is: 123456
Then your HTTP request should include the following header:
Authorization: EQ-Key 123456
Usage Example
curl -X GET "https://api.jobseq.com/v1/example-endpoint" \
-H "Authorization: EQ-Key 123456" \
-H "Accept: application/json"
fetch("https://api.jobseq.com/v1/example-endpoint", {
method: "GET",
headers: {
"Authorization": "EQ-Key 123456",
"Accept": "application/json"
}
})
.then(response => response.json())
.then(data => console.log(data));
import requests
headers = {
"Authorization": "EQ-Key 123456",
"Accept": "application/json"
}
response = requests.get("https://api.jobseq.com/v1/example-endpoint", headers=headers)
print(response.json())
Security Considerations
- Do not expose your API key in client-side code or version control repositories. If you need to access the JobsEQ API directly from client-side code, please contact API Support for information about
HMAC Authorization
. - JobsEQ may throttle or reject requests with missing or malformed authorization headers.
Common Errors
HTTP Status | Meaning | Possible Cause |
---|---|---|
401 Unauthorized | Missing or invalid Authorization header | No header, incorrect prefix, or expired key |
403 Forbidden | Valid key but insufficient permissions | Key does not have access to requested resource |
429 Too Many Requests | Rate limit exceeded | Too many requests in a short period |
Updated about 2 months ago