Authentication
Secure your integration using API Key authentication.
Authentication
The Donutwork API uses API Keys to authenticate requests. You can view and manage your API keys in the Donutwork Dashboard.
Authorization Header
All API requests must include your API Key in the Authorization HTTP header as a Bearer token.
Authorization: Bearer <your_api_key>Obtaining an API Key
Donutwork is currently in a controlled rollout phase. Access is granted to partners and early adopters through the following process:
Request Access
Submit a request to the Donutwork team outlining your integration use case.
Review & Provisioning
Our team will review your requirements and provision the necessary environments.
Environment Keys
Upon approval, you will be provided with distinct keys for:
- Staging: For development, testing, and sandbox experimentation.
- Production: For live, customer-facing traffic.
Connectivity and Health Checks
Use these endpoints to validate your authentication credentials and monitor API availability.
System Ping
Verify the operational status of the Donutwork API environment.
ping:readApiAccessPermission::PING_READQuery Parameters
No query parameters required.
Responses
API is operational and responding.
{
"status": "success",
"env": "production",
"RRT": "0.08 ms"
}Connection Metadata
Retrieve detailed information about your current connection, including client IP and protocol negotiation.
connection:readApiAccessPermission::CONNECTION_READQuery Parameters
No query parameters required.
Responses
Connection metadata retrieved successfully.
{
"client": {
"userAgent": "axios/1.6.0",
"ips": {
"ipv4": "192.168.1.1"
}
},
"endpoint": {
"apiVersion": "2026-02-01",
"env": "production",
"protocol": "HTTP3"
}
}