Skip to main content

Пошук ключів співробітника POST /api/external/company/employee/pkeys/search

REQUEST

URL


Метод запиту

POST

URL запиту

/api/external/company/employee/pkeys/search

URL параметри

companyCode (обов’язково) - код Компанії;

employeeIpn (обов’язково) - ІПН/РНОКПП співробітника.

Authorization


Auth type

API key

Key / Value

x-system-id - токен, отриманий при підключенні

Headers

 

Content-Type

application/json

REQUEST

 

JSON Body

В тілі запиту методу передається об’єкт ESSPrivateKeysQuery

 

 JSON приклад запиту:

 

{
  "statuses": ["ACTIVATED"],
  "stamp": false,
  "limit": {
    "offset": 0,
    "count": 20
  }
}
RESPONSE

В тілі відповіді передаються статус 200 та масив об'єктів ESSPrivateKey.

JSON  приклад відповіді:

[
  {
    "id": 1001,
    "name": "Ключ співробітника",
    "uuid": "019ec000-0000-7000-8000-000000000001",
    "status": "ACTIVATED",
    "storeType": "HSM",
    "keyType": "UA",
    "stamp": false,
    "validFrom": 1717200000,
    "validTo": 1780272000,
    "requests": [],
    "certificates": []
  }
]
CURL 
curl -X POST 'https://host/api/external/company/employee/pkeys/search?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -H 'Content-Type: application/json' \
  -d '{
    "statuses": ["ACTIVATED"],
    "stamp": false,
    "limit": {"offset": 0, "count": 20}
  }'
Помилки 
HTTP type Опис
400 employee_not_found Співробітник не знайдений.
403 company_access_denied Немає доступу до company.