Skip to main content

Перевірка ключа та пароля PATCH /api/external/company/pkey

Метод перевіряє, що ключ належить компанії, привʼязаній до зовнішньої системи, активований, має дозволений для зовнішньої системи usage, а переданий пароль підходить до ключа.

Метод доступний лише за наявності тарифної опції TARIFF_API_SIGN_INTEGRATION

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/external/company/pkey

URL параметри

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

Authorization

Auth type

 API key

Key / Value

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

Headers

  

Content-Type

multipart/form-data

REQUEST

  

JSON Body

key (обов’язково) string UUID - UUID ключа, який треба перевірити

password (обов’язково) string - Base64 від RSA-encrypted bytes пароля ключа. Шифрувати public key з /api/external/key.

 

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

 

{
  "key": "019ec000-0000-7000-8000-000000000001",
  "password": "BASE64_RSA_ENCRYPTED_KEY_PASSWORD"
}
RESPONSE

В тілі відповіді передається статус 200, якщо ключ пройшов усі перевірки та пароль правильний.

CURL
curl -X PATCH 'https://host/api/external/company/pkey?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "019ec000-0000-7000-8000-000000000001",
    "password": "BASE64_RSA_ENCRYPTED_KEY_PASSWORD"
  }'
Помилки
HTTP type Response body Опис
400 — відсутній Ключ не знайдено, не належить компанії, не активований або його usage не дозволено зовнішній системі.
400 tariff_option_unavailable JSON У company немає тарифної опції TARIFF_API_SIGN_INTEGRATION.
403 access_denied JSON Невалідний x-system-id або IP не дозволений.
403 company_access_denied JSON Компанію не знайдено або вона не привʼязана до зовнішньої системи.
406 — відсутній Пароль ключа неправильний.
426 — відсутній password не є коректним base64 ciphertext або ciphertext не вдалося розшифрувати.
Back to top