API /ping

computer

The /ping API is provided in order to check the status of the Coin Publishers APIs.

A successful response indicates that the APIs are functioning correctly.

Requests for this API should be made to:

GEThttps://coinpublishers.com/v1/api/ping

This request takes no parameters. No authentication is necessary.

The following is a example of a Curl request to the API:

curl
-H "Accept: application/json"
-G https://coinpublishers.com/api/v1/ping
Responses

The following is a list of the possible responses:

The following is an example of a successful response:

{
  "status": {
    "error_code": 200,
    "error_message": "",
    "result": "OK",
    "timestamp": "2018-06-06T07:52:27.273Z"
  }
}

The following is an example of a failed response:

{
  "status": {
    "error_code": 401,
    "error_message": "Unauthorized access - please check your API key",
    "result": "NOK",
    "timestamp": "2018-06-06T07:52:27.273Z"
  }
}
Response Schema

The following is a description of the fields that can be returned in a response:

error_code
number
HTTP error code - 200 if successful
error_message
string
The reason why the request failed
result
string
"OK" if response successful
timestamp
timestamp
Current timestamp