P-SIGN запрос статуса

Содержание

1 Содержание
2 Описание
3 API параметры
4 Примеры запроса
5 Callback

Описание

Метод используется для получения мерчантом статуса подписания документов (если не был обработан коллбек).

API параметры

HTTP METHOD: POST

API ENDPOINT: https://sign.platon.ua/api/v1/smart-id/status

Параметр	Значение	Описание

Параметр	Значение	Описание
`action` обязательно	`GET_SMART_ID_STATUS`
`client_key` обязательно	String
`client_request_id` обязательно	String	Уникальный ключ мерчанта в системе Platon
`hash` обязательно	String	Подпись `md5( strtoupper( strrev($client_password). strrev($client_request_id) ) )`

Примеры запроса

<?php
declare(strict_types=1);

$curl = curl_init();

// ---------- ПЕРЕМЕННЫЕ
$client_request_id = '0.13740000 1615280116'; 
$api_key = 'PL-111111'; 
$api_password = 'bf2a05b80dd649bdb365fe2d242e4cd8'; 

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://sign.platon.ua/api/v1/smart-id/status',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => 'utf-8',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_SSL_VERIFYHOST => false,
    CURLOPT_SSL_VERIFYPEER => false,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => [
        'action' => 'GET_SMART_ID_STATUS',
        'client_key' => $api_key,
        'client_request_id' => $client_request_id,
        'hash' => md5(strtoupper(strrev($api_password).strrev($client_request_id))),
    ],
]);

$response = curl_exec($curl);

if (! $response) {
    echo "Error --> ".curl_error($curl)."\n";
}

curl_close($curl);
echo "Success --> \n";
var_dump(json_decode($response));

Callback

Промежуточный ответ:

{
  "action":"GET_SMART_ID_STATUS",
  "client_request_id":"0.92410500 1615368966",
  "result":"ACCEPTED",
  "status":"SUCCESS"
}

Параметр	Значение	Описание

Параметр	Значение	Описание
`action`	`GET_SMART_ID_STATUS`
`client_request_id`	String	Уникальный идентификатор запроса на стороне мерчанта
`result`	`ACCEPTED` `DECLINED`
`status`	`INIT` `WAITING` `SUCCESS` `DECLINE` `ERROR`	Статус запроса

При успешном запросе:

{
  "action":"GET_SMART_ID",
  "status":"SUCCESS",
  "request_id":"1d7f09c9-d4ec-42ba-910c-44c92788c3b7",
  "client_request_id":"0.689538001615372279",
  "channel":"diia",
  "name":"\u041e\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440",
  "second_name":"\u041b\u0435\u043e\u043d\u0456\u0434\u043e\u0432\u0438\u0447",
  "surname":"\u0420\u043e\u0434\u0438\u043d\u0430",
  "itn":"3475806070"
}

Параметр	Значение	Описание

Параметр	Значение	Описание
`action`	`GET_SMART_ID`
`result`	`SUCCESS`
`request_id`	String	Уникальный идентификатор запроса на стороне Platon
`client_request_id`	String	Уникальный идентификатор запроса на стороне мерчанта
`channel`	String	Канал получения запроса
`signatures`	List	Список с результатами подписания
`$_FILES['signatures']`	File	Подписанные файлы
`Name`	String	Имя подписана
`Second_Name`	String	Отчество подписана
`Surname`	String	Фамилия подписана
`ITN`	String	ИНН код подписанта
`errorMessage`	String	Текст ошибки
`hash`	String	Шифрованная подпись запроса

При неуспешном запросе:

{ 
  "action":"GET_SMART_ID",
  "client_request_id":"0.58243700 1615373685",
  "result":"DECLINED",
  "error_message":"The callback url field is required."
}

Параметр	Значение	Описание

Параметр	Значение	Описание
`action`	`GET_SMART_ID`
`result`	`DECLINED`	При отказе нашей системы или SmartID
`request_id`	String	Уникальный идентификатор запроса на стороне Platon
`client_request_id`	String	Уникальный идентификатор запроса на стороне мерчанта
`error_message`	String	Причина отказа