Headers¶
Authentication¶
All requests to the Operator API must be authenticated. This API uses the basic authentication method. You may find more information about the basic authentication here.
Each API request should contain a header field in the form of:
header 'Authorization: Basic <credentials>'
where username and password are joined by a single colon ‘:‘ and are encoded in Base64.
Refer to the Accessing the API section on how to receive your basic authentication credentials.
Content negotiation¶
All requests to the Operator API should include the following header:
Content-Type: application/vnd.api+json
without any media type parameters.
Clients that include the JSON:API media type in their Accept
header MUST
specify the media type there at least once without any media type
parameters.
Clients MUST ignore any parameters for the application/vnd.api+json
media
type received in the Content-Type
header of response documents.
The server will respond with a 415 Unsupported Media Type status code if
a request specifies the header Content-Type:
application/vnd.api+json
with any media type parameters.
The server will respond with a 406 Not Acceptable status code if a
request’s Accept header contains the JSON:API media type, and all
instances of that media type are modified with media type parameters.