Skip to main content

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:

MethodDescription
GETRetrieve a resource or a list of resources.
POSTCreate a new resource.
PUTUpdate an existing resource (full update).
PATCHPartially update an existing resource.
DELETERemove a resource.

HTTP Status Codes

The API returns standard HTTP status codes to indicate the success or failure of a request:

CodeStatusDescription
200OKRequest succeeded.
201CreatedResource was successfully created.
204No ContentRequest succeeded, but there is no content to return.
400Bad RequestThe request was invalid or missing required parameters.
401UnauthorizedAuthentication failed or was missing.
403ForbiddenYou do not have permission to access the resource.
404Not FoundThe requested resource could not be found.
429Too Many RequestsRate limit exceeded.
500Server ErrorAn internal error occurred on our servers.