Поддержка

Инструкция портала ВТБ API

Тарифный план - это набор ресурсов API или подмножеств ресурсов из одного или нескольких API. План может включать различные комбинации команд HTTP GET, PUT, POST и DELETE из разных API или содержать все команды GET из нескольких API. План может устанавливать единое ограничение частоты для всех ресурсов или разные ограничения для каждого ресурса. Ограничение частоты определяет максимальное количество запросов из приложения в течение указанного периода времени.

Ознакомьтесь с различными планами в портале разработчиков и выберите оптимальный вариант с учетом ваших требований. Для использования некоторых планов требуется специальное разрешение. После отправки запроса администратор API рассмотрит вашу заявку и при необходимости свяжется с вами для обсуждения подробностей. Также есть планы, не требующие специального разрешения.

Количество запросов для разных API, отправленных вашим приложением, показано на странице приложения.

Выберите 'Приложения' в главном меню, а затем выберите свое приложение. В разделе 'Подписка на планы' отображаются все планы, доступные для приложения.

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

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

Сведения об API включают таблицу операций, содержащихся в API. В таблице указаны доступные методы (GET, POST, PUT, DELETE, PATCH, HEAD или OPTIONS) и путь, используемый ресурсом.

На странице ресурса доступна более подробная информация, включая разрешенные параметры, возвращаемые данные, коды возврата и их значение.

С помощью кнопки 'Попробовать' можно протестировать ресурс непосредственно в портале разработчиков.

Если API требует ввода Client ID / Client Secret, укажите идентификационные данные в верхней области раздела 'Попробовать'.

При добавлении приложения вы получаете Client ID / Client Secret для этого приложения.
При вызове API, который требует идентификации приложения с использованием Client ID / Client Secret, необходимо предоставить идентификационные данные.
Для того чтобы зарегистрировать приложение, выберите Приложения в главном меню и нажмите ссылку 'Создать приложение'. После ввода имени и описания приложения будут показаны Client ID / Client Secret.
Client Secret выводится однократно, поэтому рекомендуем записать его.
Client Secret необходимо вводить при вызове API, который требует идентификации приложения с использованием Client ID и Client Secret.
Обратите внимание, что Client Secret посмотреть повторно нельзя, можно только перевыпустить.

Client Secret приложения хранится в зашифрованном виде; таким образом, вы не сможете извлечь открытую информацию, если забыли пароль.

В этом случае можно выполнить сброс пароля, в результате чего новый пароль заменит хранимое значение и будет возвращен вам.

Для сброса пароля откройте 'Приложения' в главном меню, выберите интересующее вас приложение и нажмите ссылку 'Сбросить' в разделе 'Пароль клиента'.

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