instance-id method

Description

Registering an instance of the application.

Request parameters:

Parameter Type Description
client_id string Application ID.

Returns

Response fields:

Parameter Type Description
status string Operation result code (see the table).
error string Error code (explanation of the "status" field). Present only for errors (see the table).
instance_id string ID of the application instance.

Operation processing result codes:

Code Description
success Success.
refused Refusal. The reason for refusal is returned in the error field.

If an error occurred while processing the transaction, the error code is returned:

Code Description
illegal_param_client_id Invalid value for the client_id parameter (non-existing or blocked). The application cannot work with this client_id.

Examples

Request example:

POST /api/instance-id HTTP/1.1
Host: money.yandex.ru
Content-Type: application/x-www-form-urlencoded
Content-Length: 75

client_id=1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1

Example of a response document when successful:

{"status": "success", "instance_id": "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1"}

Example of a response document for an error:

{"status": "refused", "error": "illegal_param_client_id"}