← Назад
referenceПочатківець⏱️ 2 хв читання

Як перейти в тестовий режим

Заголовок X-Test-Mode дозволяє працювати з тестовими даними API, не торкаючись реальних записів — приклад запиту.

#testing#reference#x-test-mode

Щоб перевірити інтеграцію, не ризикуючи зачепити реальні дані, додайте до запиту заголовок X-Test-Mode.

Важливо: Для користування тестовим режимом напишіть нам про бажання скористатись тестовим режимом і ми надішлемо вам API-ключ для тестового режиму.

Заголовок для тестового режиму(Test Mode)

X-Test-Mode: 1

Додається поруч зі звичайними заголовками запиту (Authorization тощо) — жодних інших змін у запиті не потрібно.

Приклад запиту

curl -X GET \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -H "User-Agent: <НазваВашогоЗастосунку>/1.0" \
  -H "X-Test-Mode: 1" \
  https://api.bm.parts/profile/me

Працює для будь-якого ендпоінта

X-Test-Mode — глобальний заголовок, не прив’язаний до конкретного методу: додайте його до будь-якого запиту до API, і він однаково спрацює для всіх ендпоінтів, включно з отриманням прайсу (POST /prices/list). Окремо перевіряти підтримку по кожному методу не потрібно.

Пошук

Пошук ендпоінтів, гайдів, туторіалів, реліз-ноутів по всьому порталу