WAKU Robotics
Customer Portals are now available!Get Started
API Documentation was updated!Learn more
Overview
WAKU Care - Public API 1.0.0
Section titled “WAKU Care - Public API 1.0.0”General API Documentation
The WAKU Care Public API is the official API to manage and track cases and query their status across your whole robotics fleet.
Authentication
This API uses API keys to authenticate requests. API keys are bound to deployments. One deployment can have multiple API keys.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via an HTTP bearer token via HTTP headers in the form of Authorization: Bearer <API_KEY> as specified by RFC 6750.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Errors
The API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., the authentication failed, a required parameter was omitted, etc.). Codes in the 5xx range indicate a server-sided error with the API.
The body of the response will be JSON in the following format:
{
"code": 400,
"message": "Bad Request"
}Here is a list of popular response codes:
| Code | Description |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 404 - Not Found | The requested resource doesn’t exist or the API key does not have valid access permissions. |
The full list of HTTP status codes is specified in RCF 9110.
Workspaces
In WAKU Care, a workspace is the top-level entity by which customers are grouped. A workspace can be used to define company-wide checklist templates, for example. Workspaces can have a parent -child relation to each other. For example, robot manufacturers or integrators might manage each of their customers in a separate workspace which is a child of the manufacturer’s workspace. This allows for fine-granular user management and even collaboration between the robot manufacturer and their customers.
Deployments
Deployments are part of workspaces and usually represent a specific building or site. A workspace may have any number of deployments. Deployments contain devices, cases, work orders, strategies, and inventory.
Authentication
Section titled “Authentication”APIKey
Section titled “APIKey”Type “Bearer” followed by a space and JWT token.
Security scheme type: apiKey
Header parameter name: Authorization