Руководство пользователя


Contents


API ПриватБанк

API ПриватБанк определяет набор HTTP сервисов систем ПриватБанка доступных внешним приложениям.
Благодаря широкому распространению протокола HTTP, API ПриватБанк легко интегрируется с любыми платформами, независимо от языка программирования или используемых технологий.

На самом деле API предоставляет фантастические возможности и сфера применения API ничем не ограничена. Появление API ПриватБанка поможет теперь нашим пользователям решать самые неординарные задачи, интегрируясь с нашими сервисами. А количество функций нашего API со временем будет только расти.

Добавление нового приложения на сайте API ПриватБанк

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

По нажатию кнопки Добавить в блоке Приложения откроется форма добавления нового приложения.

Заполните обязательные поля отмеченный звездочкой (*) и Сохраните Ваше приложение.
Поля для заполнения:

  • Название приложения (*),
  • Описание приложения (*),
  • Добавить траффик - выбор данного параметра активирует доступ вашего приложению к API.

Получение пароля и Client ID для работы приложения с предоставляемыми API ПриватБанка

Один пользователь может зарегистрировать неограниченное количество приложений.

  • После сохранения приложения сразу же отобразится окно с необходимым паролем и Client ID для Вашего приложения.

Здесь доступны следующие опции:
1. Возврат на страницу редактирования приложения по кнопке Редактировать.
2. Включение/Выключение траффика, проходящиго через приложение.
3. Пересоздание пароля.

  • Для уже существующих приложений получение пароля и Client ID доступно в списке приложений. Для этого кликните на названии приложения, после чего откроется окно с необходимой информацией.

Настройка доступа приложения к API ПриватБанка

На Вашем Дашборде в разделе Доступ просто с помощью кнопок ON/OFF настройте доступ к определенным разделам API ПриватБанка. При подключении отображается количество возможных запросов на еденицу времени.

Редактирование Профиля на сайте API ПриватБанк

При первичном входе вы сразу попадаете на страницу Редактирования профиля.

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

Обращаем внимание, что предоставленная информация о электронном адресе поможет ПриватБанку ответить на Ваше обращение, в случае возникновения проблем в работе API ПриватБанка.

Нужно знать

API представляют собой набор сервисов, вызываемых по HTTP-протоколу любым методом (POST,GET и т.д.)
Для всех входных и выходных данных API используется кодировка UTF-8.
Для ответов сервером используется базовый формат JSON.

API доступны любому авторизованному пользователю. В зависимости от способа авторизации предоставляется доступ к определенным группа API. Для авторизовавщихся пользователей с помощью Приват24 доступен весь список предоставляемых API.

Для пользователей, которые прошли авторизацию с помощью Google ограничен доступ к следующим группам API:

  • платежные

Возможные ошибки

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

Поддерживаемые заголовки для определения, в каком виде присылать HTTP-ответ, в случае возникновения ошибок в работе API:

  • text/plain
  • text/xml
  • application/xml
  • application/json

Сответсветственно структура ответов:

  • "Описание"
  • <error>Описание</error>
  • {"error":"Описание"}

Таблица возможных ошибок

Код ошибки Описание
400
Неправильный запрос
401
Требуется авторизация
Сессия истекла
403
Неправильные данные авторизации
У приложения выключен траффик
Указанное приложение не найдено
Превышена квота
500
Внутренняя ошибка шины

Задать вопрос по возникшей проблеме

Для того, чтобы обратиться к ПриватБанку для решения возникшей проблемы в работе с сайтом API ПриватБанк необходимом описать проблему в письме. Адрес почты link@privatbank.ua

Обращаем Ваше внимание, что предоставленная информация о электронном адресе в Профиле поможет ПриватБанку ответить на Ваше обращение, в случае возникновения проблем в работе API ПриватБанка.