OAK API

The API implements oak.cgi as its communications interface and supports the following methods:

API Discovery

id=oak

Use this example to retrieve the owner authentication key to register your device. This operation requires unhindered internet access from your device, i.e. involving a proxy server will cause the OAK retrieval to fail.

1. Request the OAK with the following JSON request:

http://<servername>/axis-cgi/oak.cgi

{
  "apiVersion": "1.0",
  "context": "Client defined request ID",
  "method": "getOAK"
}

2. Parse the JSON response.

{
  "apiVersion": "1.0",
  "context": "Client defined request ID",
  "method": "getOAK",
  "data": {
    "oak": "OAK"
  }
}

API references

• getOAK

This API method is used to retrieve the owner authentication key. Please note that this operation requires unhindered internet access from your device, i.e. involving a proxy server will cause the OAK retrieval to fail and the error response 1100 - Internal error will be returned.

Request

Security level

Administrator

Method

POST

http://<servername>/axis-cgi/oak.cgi

{
  "apiVersion": "<Major>.<Minor>",
  "context": "<ID string>",
  "method": "getOAK"
}

Return value - Success

HTTP code

200 OK

Content-type

application/json

{
  "apiVersion": "<Major>.<Minor>",
  "context": "<ID string>",
  "method": "getOAK",
  "data": {
    "oak": "<oak string>"
  }
}

Return value - Failure

HTTP code

200 OK

Content-type

application/json

No specific failure exist for this method. See Error handling for a full list of potential error codes and general errors.

This API method is used to retrieve a list of supported API versions.

Request

Security level

Administrator

Method

POST

http://<servername>/axis-cgi/oak.cgi

{
  "context": "<ID string>",
  "method": "getSupportedVersions"
}

Return value - Success

HTTP code

200 OK

Content-type

application/json

{
  "apiVersion": "<Major>.<Minor>",
  "context": "<ID string>",
  "method": "getSupportedVersions",
  "data": {
    "apiVersions": [ "<Major1>.<Minor1>", "<Major2>.<Minor2>" ]
  }
}

Return value - Failure

HTTP code

200 OK

Content-type

application/json

No specific failure exist for this method. See Error handling for a full list of potential error codes and general errors.

The following table lists the general errors that can occur for any of the JSON requests.

Error response body syntax

All potential failures will return with the following JSON response.

{
  "apiVersion": "<Major>.<Minor>",
  "context": "<ID string>",
  "method": "<method string>",
  "error": {
    "code": <integer error code>,
    "message": "<string>"
  }
}