Проверка API-ключа поставщика

Первый вызов при настройке интеграции: убедиться, что ключ <code>bk_sup_</code> привязан к нужному юрлицу (ИНН, название), и узнать defaultImportMaskId для автоматического разбора файлов.

Первый вызов при настройке интеграции: убедиться, что ключ bk_sup_ привязан к нужному юрлицу (ИНН, название), и узнать defaultImportMaskId для автоматического разбора файлов.

Зачем нужен метод

Первый вызов при настройке интеграции: убедиться, что ключ bk_sup_ привязан к нужному юрлицу (ИНН, название), и узнать defaultImportMaskId для автоматического разбора файлов.

Когда использовать

Smoke-test после выдачи ключа в drawer поставщика; health-check cron раз в сутки.

Эндпоинт

POST /v1/supplier/profile/get

Аутентификация: API-ключ в заголовке X-Api-Key (префикс bk_sup_). projectId и actor id в body не передаются — берутся из ключа.

Scope: supplier:codes:read

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

{
  "meta": { "requestId": "optional-uuid" },
  "data": {}
}

Пример ответа

{
  "success": true,
  "data": {
    "supplierId": "c219ef09-ae2f-4d08-af11-7cd51006fae4",
    "name": "Промомед",
    "legalName": "АО Промомед",
    "inn": "7701234567",
    "isActive": true,
    "defaultImportMaskId": "mask-uuid",
    "contactEmail": "integration@promomed.ru"
  }
}

Ошибки

  • UNAUTHORIZED / ACCESS_DENIED — нет доступа
  • VALIDATION_ERROR — некорректное тело
  • NOT_FOUND — сущность не найдена
  • RATE_LIMIT_EXCEEDED (429) — превышен лимит

cURL

curl -X POST "https://api-external.promanta.ru/v1/supplier/profile/get" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"data": {}}'

См. также

Оцените статью — нам важна ваша обратная связь.

0 (0 оценок)