Технический протокол API «Подарок в Квадрате»
Добро пожаловать в документацию API. Здесь вы найдете подробное описание методов, структур запросов и ответов, а также примеры кода и инструкции для интеграции.
Разделы документации
- История изменений: Обновления и изменения в протоколе.
- Общая информация:
- Термины: Основные понятия и определения.
- Шифрование данных: Алгоритмы и примеры шифрования запросов.
- Проверка баланса:
- Метод get_balance: Уточнение баланса партнера.
- Виртуальные карты:
- Метод create: Создание виртуальной карты.
- Метод commit: Подтверждение выпуска карты.
- Метод rollback: Отмена выпуска карты.
- Переводы на карты, БРС:
- Метод transfer: Перевод денежных средств на карты.
- Метод status: Проверка статуса перевода.
- Метод check: Уточнение параметров перевода.
- Статусы переводов: Возможные статусы переводов.
- Переводы на карты по номеру телефона, БРС:
- Метод banks: Получить список банков-получателей.
- Метод remittance: Перевод на карту по номеру телефона.
- Метод status: Уточнение статуса перевода.
- Переводы на карты, ТКБ:
- Метод transfer: Перевод средств на банковские карты.
- Метод status: Проверка статуса перевода.
- Переводы на карты, по номеру телефона, ТКБ:
- Метод banks: Список банков-получателей.
- Метод transfer: Перевод на карту по номеру телефона.
- Метод status: Уточнение статуса перевода.
- Переводы на мобильные телефоны:
- Метод create: Выпуск карты на пополнение мобильного телефона.
- Метод commit: Подтверждение выпуска карты на пополнение мобильного телефона.
- Метод rollback: Отмена выпуска карты на пополнение мобильного телефона.
- Мобильные операторы: Возможные мобильные операторы.
- Сертификаты Ozon:
- Метод order: Создание заказа на выпуск сертификата.
- Метод status: Проверка статуса заказа на сертификат.
- Метод certificate: Получение данных о выпущенном сертификате.
- Метод cancel: Отмена выпуска сертификата.
- Статусы операций: Возможные статусы операций с сертификатами.
- Колбэки: Описание обратных вызовов и их форматов.
- Ошибки: Полный список возможных ошибок и их описания.
Быстрый старт
- Получите доступ к API, заключив договор и получив логин, пароль и открытый ключ.
- Ознакомьтесь с описанием методов.
- Настройте шифрование для защищенной передачи данных. Подробнее в разделе Шифрование.
- Интегрируйте API в свое приложение, используя примеры кода, приведенные в документации.
Полезная информация
- Для работы с API необходимо получить:
- Логин.
- Пароль.
- Открытый ключ для шифрования данных.
- Перед началом интеграции убедитесь, что вы добавили свой IP-адрес в список доверенных.
- Для работы с CallBacks необходимо дополнительно получить:
- Секрет.
Примечания
- Все запросы должны отправляться с использованием HTTPS.
- Шифрование данных обязательно для параметров, отмеченных в описании методов.
- В случае возникновения ошибок обратитесь в техническую поддержку по адресу: support@prostodar.ru.
Контакты
Если у вас возникли вопросы или требуется помощь, свяжитесь с вашим менеджером сопровождения.