Vendor's endpoint accessibility check (get ping)

Last updated on September 28, 2022

From time to time, Sber Smart Home pings a vendor’s endpoint to make sure it is available. If a vendor’s endpoint becomes unavailable, users cannot manage the vendor devices in Sber Salut, SberBox, SberPortal and other devices supported with Sber assistants.

Query format

Sber Smart Home sends a query to the vendor's endpoint. For the headers, see Query headers.

GET /v1/ping

Response format

Success response:

HTTP/1.1 200 OK

When an error occurs, an object of the Common error (common error) type should be returned:

{
    "code": integer,
    "message": string,
    "details": list<string>
}

Sample query and response

Sber Smart Home sends a query (ping) to make sure the vendor's endpoint is available.

Query:

curl -i -X GET /v1/ping HTTP/1.1 \
-H Host: example.com \
-H Content-Type: application/json \
-H Authorization: Bearer qwerty-1234-... \
-H X-Request-Id: abcd-0000-ifgh-...

Success response:

HTTP/1.1 200 OK

Error response:

{
    "code": 503,
    "message": "Server unavailable",
    "details": []
}