Ваше API
Описание
Ваша платежная система (баланс, по умолчанию VU-Money USD) поддерживает работу через собственное API.
Это же касается и всех дополнительных валют баланса, которые вы создадите.
Доступные функции
Invoice - операция по выставлению счета. Пользователь получает ссылку на оплату сгенерированного счета (инвойса).
Callback - функция уведомлений об оплате инвойса. Отправляет детали оплаченного инвойса на url, указанный при его создании.
Withdraw - операция по выплатам. В автоматическом режиме осуществляет перевод с баланса пользователя на указанные реквизиты.
Details - операция по получению деталей транзакции или инвойса.
Balances - операция по получению текущих балансов пользователя.
Ticker - публичная операция (не требующая ключей API), выдающая курсы по всем активным направлениям в формате json.
Code create - операция создания кода.
Code apply - операция погашения кода.
Code get - операция получения деталей кода.
Настройки
Первое, что нужно сделать - включить саму API. Это можно сделать здесь: Обмен валют - Настройки модуля - Статус API баланса
Рядом с этой настройкой есть вторая: "Статус функции Выставление счета". Если она отключена, в API будет недоступна операция Invoice.
Второе - настройки групп. Необходимо активировать опцию "Разрешать использование API" для всех групп пользователей, которым вы хотите это разрешить.
Далее - балансы и направления. Добавьте и настройте все необходимые валюты балансов (добавление платежной системы с API "balance").
Обязательно укажите "Код системы" для всех платежных систем (включая балансы), которые будут работать через API.
Настройте типы обменов: автоматический обязателен для выплат (withdraw), выставление счета для invoice.
Включите все нужные направления, типы в них и настройте курсы.
Вы можете настраивать направления между одной и той-же платежной системой для операции invoice.
API учитывает все указанные комиссии.
Если вы используете направления, для которых обязательна верификация карты - операция withdraw будет выдавать ошибки при попытке выплаты на не верифицированную карту (Card is not verified).
Вы можете отключить проверку верификации для определенной группы пользователей (Опция: "Обязательная верификация платежной карты").
Работа API
Документация вашей API доступна по адресу: https://ваш_сайт/api/docs
В документации автоматически подставляются адреса к вашей API и коды платежных систем.
Проверяйте раздел документации "Коды платежных систем", чтобы убедиться в их правильной настройке.
Если платежная система не отображается - одна или несколько причин: она отключена, нет активных направлений, нет направлений с нужными типами обмена, не введен код системы.
Если не отображается операция invoice - тип выставление счета не включен в платежной системе или у нее нет активных направлений с этим типом.
Если не отображается операция withdraw - тип автообмен не включен в платежной системе или у нее нет активных направлений с этим типом.
Для использования вашей API пользователи должны сгенерировать ключи API. Это можно сделать только в панели пользователя.
Через админку вы можете только просматривать список открытых ключей (секретные всегда скрыты и закодированы) и удалять их (Дополнительно - API ключи) .
Для всех запросов к API пишутся логи. Если возникают проблемы с его работой - используйте логи для поиска причин (Дополнительно - Логи API).
Last updated