RESTful API Principles
The Blueink API is built on RESTful principles, using standard HTTP methods and status codes to manage resources.
Base URL
All API requests are made to:
https://api.blueink.com/api/v2/
HTTP Verbs
We use standard HTTP methods for different types of operations:
| Method | Description |
|---|---|
GET | Retrieve a resource or a list of resources. |
POST | Create a new resource. |
PUT | Update an existing resource (full update). |
PATCH | Partially update an existing resource. |
DELETE | Remove a resource. |
HTTP Status Codes
The API returns standard HTTP status codes to indicate the success or failure of a request:
| Code | Status | Description |
|---|---|---|
200 | OK | Request succeeded. |
201 | Created | Resource was successfully created. |
204 | No Content | Request succeeded, but there is no content to return. |
400 | Bad Request | The request was invalid or missing required parameters. |
401 | Unauthorized | Authentication failed or was missing. |
403 | Forbidden | You do not have permission to access the resource. |
404 | Not Found | The requested resource could not be found. |
429 | Too Many Requests | Rate limit exceeded. |
500 | Server Error | An internal error occurred on our servers. |