Тестирование API-запросов в Postman

Содержание

Тестирование API-запросов в Postman#

В этой статье покажем, как подготовить и отправить тестовый API-запрос в Direct API через Postman.

Что понадобится#

Перед началом работы подготовьте:

доступ в личный кабинет i-digital Direct;
API-ключ нужного типа, подробнее как создать API-ключ;
Postman или его веб-версию;
описание метода, который вы хотите проверить.

Как работает авторизация#

Direct API использует Bearer-авторизацию.

В запросе нужно передавать заголовок:

Authorization: Bearer {API_KEY}

Где {API_KEY} — ключ, созданный в личном кабинете.

Дополнительно для JSON-запросов обычно используется заголовок:

Content-Type: application/json

Базовый адрес API:

https://direct.i-dgtl.ru/api/v1

{% hint style=»info» %}

Важные особенности Direct API#

Direct API предназначен для вызовов с защищенной серверной части;
при попытке обращаться к API напрямую из браузера возникнет CORS-ошибка;
при необходимости доступ по API-ключу можно ограничить по IP-адресам через поддержку support@i-dgtl.ru; {% endhint %}

Установка и запуск Postman#

Для работы с запросами откройте приложение Postman или его веб-версию.

После запуска:

Создайте новый запрос.
Выберите HTTP-метод, указанный в описании нужного метода API: GET, POST и другие.
Укажите URL запроса.
При необходимости добавьте заголовки и тело запроса.

Проверка соединения#

Перед работой с авторизованными методами удобно проверить доступность сервиса через тестовый метод:

GET https://direct.i-dgtl.ru/api/v1/ping

Для этого метода авторизация не требуется.

Если сервис доступен, в ответе вернется:

PONG

Такой запрос помогает убедиться, что соединение с API установлено корректно.

Пример авторизованного запроса#

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

GET https://direct.i-dgtl.ru/api/v1/balance
Authorization: Bearer {API_KEY}

В Postman для этого:

Выберите метод GET.
Укажите URL https://direct.i-dgtl.ru/api/v1/balance.
На вкладке Headers добавьте заголовок Authorization со значением Bearer {API_KEY}.
Нажмите Send.

При успешном выполнении в ответе вернется объект с балансом аккаунта, например:

{
  "RUB": 1200.00
}

Как отправить POST-запрос#

Если нужный метод работает по POST, настройка в Postman будет такой:

Выберите метод POST.
Укажите URL из документации нужного метода.
Добавьте заголовок Authorization: Bearer {API_KEY}.
Добавьте заголовок Content-Type: application/json.
Перейдите на вкладку Body.
Выберите режим raw.
Убедитесь, что выбран формат JSON.
Вставьте JSON-тело запроса из описания нужного метода.

Общий пример структуры:

{
  "param1": "value",
  "param2": "value"
}

{% hint style=»warning» %} Набор параметров зависит от конкретного метода: отправка сообщения, работа с шаблонами, получение данных по сообщениям, верификация телефона и другие сценарии используют разные поля запроса. {% endhint %}

Частые ошибки#

401

API-ключ передан неверно;
ключ был деактивирован;
ключ был перевыпущен, и старое значение больше не работает;
запрос отправлен с IP-адреса, который не входит в разрешенный список.

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

=============================================
{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

=============================================
{
  "error": {
    "code": 4013,
    "msg": "IP not allowed"
  }
}

403

Использование неподходящего неподходящего типа (токена).

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}