Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.bspk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Requests

​
Encryption

All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons.

​
Headers

All BSPK API calls must include the following headers to authenticate the request:
keyvalue
AuthorizationBearer API_KEY

​
Responses

Responses use the customary HTTP status codes, with the most typical ones being:
CodeMeaning
Successful Responses
200OK
201OK
204No content returned
Error Responses
400Bad Request
401Unauthorized
429Too Many Requests
500Internal Server Error

​
Headers

All BSPK API calls must respond with the following headers:
keyeg. valuedescription
X-RateLimit-Limit30Request limit per time window (10 seconds)
X-RateLimit-Remaining1The number of requests left for the 10 seconds window
X-Total-Count123Total number of records found
Link<https://api.bspk.com/api/extraction/v1/emails.json?page=2>; rel=‘next’, <https://api.bspk.com/api/extraction/v1/emails.json?page=18>; rel=‘last’Links for the last and next pages
If an endpoint doesn’t support pagination (eg.: https://api.bspk.com/api/extraction/v1/ideabook_actions) the pagination related headers will be omitted.