Підписання: базовий API
- Запуск процесу підписання АЕД POST /api/v1/signature
- Отримання результату підпису АЕД GET /api/v1/signature/{signatureRequestId}
- Обробка нотифікації про підпис АЕД POST /api/v1/signature/notification
Запуск процесу підписання АЕД POST /api/v1/signature
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/signature |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
Request body schema |
documentId (string <guid>) обов'язково - Ідентифікатор АЕД
|
|
signatureType (string) обов'язково - Тип підпису:
Enum:
|
|
|
requestDeduplicationId (string <guid>) необов'язково - Ідентифікатор дедубликації запитів на підпис АЕД
|
JSON приклад запиту
{
"documentId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
"signatureType": "SignBySender",
"requestDeduplicationId": "34a13eb1-62a9-4bbd-a12a-285347701b07"
}
RESPONSE
Статус 200.
Response schema:
| signatureRequestId |
string <guid>
|
| signatureStatus |
string Enum:
|
| signatureStatusMessage |
string
|
JSON приклад відповіді
{
"signatureRequestId": "string",
"signatureStatus": "Pending",
"signatureStatusMessage": "string"
}
Отримання результату підпису АЕД GET /api/v1/signature/{signatureRequestId}
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/signature/{signatureRequestId} |
|
PATH параметри |
signatureRequestId (string) обов'язково - ідентифікатор запиту на підпис АЕД Example: 34a13eb1-62a9-4bbd-a12a-285347701b07 |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
Статус 200.
Response schema:
| signatureRequestId |
string <guid>
|
| signatureStatus |
string Enum:
|
| signatureStatusMessage |
string
|
JSON приклад відповіді:
{
"signatureRequestId": "string",
"signatureStatus": "Pending",
"signatureStatusMessage": "string"
}
Обробка нотифікації про підпис АЕД POST /api/v1/signature/notification
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/signature/notification |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
Request body schema |
notificationType (string) - тип повідомлення. Enum:
|
|
signatureRequestId (string <guid>) - Ідентифікатор запросу на підпис документу
|
|
|
hash (string) - хеш документа
|
|
|
signature (string) - підпис документа
|
|
|
errorMessage (string) - повідомлення про помилку
|
|
|
errorDescription (string) - детальне повідомлення про помилку
|
|
|
eExciseDocumentId (string <guid>) - Ідентифікатор документу в еАкцизі
|
|
|
approvalType (string) - Тип квитанції. Enum:
|
|
|
approvalResult (string) - Результат обробки в еАкциз. Enum:
|
JSON приклад запиту:
{
"notificationType": "SignatureProcessStartedNotification",
"signatureRequestId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
"hash": "string",
"signature": "string",
"errorMessage": "string",
"errorDescription": "string",
"eExciseDocumentId": "34a13eb1-62a9-4bbd-a12a-285347701b07",
"approvalType": "Approval1",
"approvalResult": "Success"
}
RESPONSE
Статус 200.
Response schema:
| signatureRequestId |
string <guid>
|
| signatureStatus |
string Enum:
|
| signatureStatusMessage |
string
|
JSON приклад відповіді:
{
"signatureRequestId": "string",
"signatureStatus": "Pending",
"signatureStatusMessage": "string"
}