Перейти к основному содержимому

Postman

Postman — это инструмент для работы с API, который позволяет отправлять запросы к сервисам и работать с их ответами. Импортируя коллекцию Tinkoff API через Postman, вы сможете тестировать запросы, изучать документацию и формировать примеры кода на разных языках.

Регистрироваться необязательно. Но если вы зарегистрируетесь, вы сможете читать документацию сразу из Postman. Для работы с API достаточно Free-аккаунта — на нём есть ограничение до 1000 запросов в месяц.

Скачать Postman

Подключение

  1. Нажмите Import, чтобы подключить коллекцию.


  2. Выберите раздел Link и вставьте ссылку на yaml документации — https://business.tinkoff.ru/openapi/docs/openapi.yaml.


  3. Оставьте стандартные настройки для импорта и нажмите Import.


    Коллекция успешно импортируется. Вы увидите дерево запросов, которые вы можете использовать.


    Чтобы прочитать описание запроса, нажмите на иконку документа справа.


Токен

Для всех запросов в Tinkoff API нужен токен, который вы получаете в личном кабинете Тинькофф Бизнеса. Чтобы Postman автоматически подставлял его во все запросы, задайте его как переменную.

Как получить токен
  1. Перейдите в любой запрос и выберите вкладку Authorization.

  2. Нажмите {{BearerToken}}Add new variable.


  3. В полях:

    • Value — введите токен, который вы получили в личном кабинете Тинькофф Бизнеса.
    • Scope — выберите Collection: Tinkoff API.

    Нажмите Set variable.


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


Параметры

Для некоторых запросов нужно передавать параметры — например, номер счёта.

По умолчанию эти поля заполнены тестовыми данными. Чтобы успешно выполнить запрос, введите ваши данные. Их можно посмотреть:

  • Для GET-запросов — на вкладке Params.


  • Для POST-запросов — на вкладке Body.


MTLS-сертификат

Некоторые запросы закрыты MTLS-сертификатом — это сделано для безопасности. Такие запросы помечены . Как выпустить сертификат.

Чтобы добавить сертификат в Postman:

  1. Перейдите в настройки, выберите вкладку Certificates и нажмите Add Certificate.


  2. Заполните поля:

    • Host — вставьте secured-openapi.business.tinkoff.ru.
    • CRT File — загрузите сертификат, который вам прислали в ответ на заявку. Также его можно выпустить в личном кабинете Тинькофф Бизнеса в разделе Интеграции. Формат файла — .pem.
    • KEY File — загрузите ваш приватный ключ, который вы генерировали в процессе выпуска сертификата.
  3. Нажмите Add.


    После добавления сертификата вы сможете отправлять все запросы, помеченные .


Postman code snippet

С помощью Postman code snippet вы можете сгенерировать примеры кода на более чем 20 языках программирования. Для этого:

  1. Откройте запрос и на панели справа нажмите </>.


  2. Выберите язык программирования.


Code snippet не поддерживает сертификаты. Если запрос помечен , добавьте сертификат самостоятельно.

Документация Tinkoff API

Чтобы посмотреть полную документацию Tinkoff API, в левом меню выберите Tinkoff APIView Documentation.


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


openapi@tinkoff.ru

АО «Тинькофф Банк» использует файлы «cookie», с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.