Общие положения
SMTP-шлюз специально предназначен для интеграции с другими системами в случае, когда доработка внешней системы для использования
чекового или пакетного API невозможна.
В таком случае возможна интеграция через файловый обмен, который работает в двух вариантах:
- Прямая отправка файлов по HTTP протоколу
- Интеграция через SMTP
Замечание
SMTP-шлюз рекомендуется к использованию владельцам информационных систем, снятых с поддержки, или компаниям, получающим выписки из Автоматических Банковских Систем.
Прямая отправка
Обмен данными с Сервисом осуществляется по каналам связи сети Интернет по протоколу HTTP(S) версии 1.1.
Данные передаются в Сервис стандартным HTTP POST запросом.
Передача информации о проведенных платежах осуществляется запросом
POST /api/externalpayment/sendfile. Формат данных - binary.
Пример отправки файла с помощью утилиты curl:
curl --request POST --data-binary @sberbank.txt https://cashbox.octonica.ru/api/v1/externalpayment/sendfile
При успешном приеме данных Сервис отвечает пустым откликом с HTTP-статусом 200 OK.
Если структура или формат данных запроса не соответствуют требованиям, Сервис отвечает откликом с HTTP-статусом 400 Bad Request.
Если при обработке данных в Сервисе возникли какие-либо внутренние ошибки, Сервис отвечает откликом с HTTP-статусом 500 Internal Server Error, в таких случаях нужно обратиться к разработчикам Сервиса.
Интеграция через SMTP
Для каждой компании заводится отельный e-mail ящик, все файлы, поступающие на этот ящик, считаются выписками из учётной системы или из АБС.
Выполняется попытка автоматически определить формат файла и далее сгенерировать запросы для пакетного API.
При удачном разборе файла, письмо помечается как обработанное.
Повторно или ошибочно отправленные письма не создают дубликатов, перед обработкой вычисляется контрольное число письма и повторная отправка игнорируется.
Ошибки обрабатываются получателем.
Совет
Перед тем, как отправлять выписки почтой, узнайте у своего банка, возможно у него уже есть интеграция с нашим пакетным или чековым API, тогда всё, что от вас требуется это арендовать у нас кассу и известить банк, далее фискализация платежей будет происходить автоматически.
Аутентификация
Аутентификация требуется только для для прямой отправки, отправка по SMTP выполняется стандартными средствами или просто любым почтовым клиентом.
Соединение происходит с использованием криптографического протокола ТLS 1.2.
Алгоритм шифрования канала: RSA.
Идентификация клиента происходит по сертификату юридического лица, выданному нашей компанией.
Сертификат должен быть использован при установлении HTTPS соединения (двухсторонняя аутентификация с использование клиентского сертификата).
Пример клиентской аутентификации для curl:
curl --cert-type pem --cert /home/apiuser/octokassa_user.pem "https://api.demo.octokassa.octonica.com/api/about"
Список поддерживаемых форматов
| Наименование | Описание |
|---|---|
| .esd | файлы формата ESD |
| СБ Длинный | выписка Сбербанк |
| СБ Короткий 1 | выписка Сбербанк |
| СБ Короткий 2 | выписка Сбербанк |
| Трансэнерго | интеграция |
| Система город | интеграция |
| ГОК | интеграция |
| Челиндбанк | выписка |
| Челябинвестбанк | выписка |
| Кыштымводоканал | выписка |
| Теплосервис и УЭД | интеграция |
| ООО "Спецсервис" | интеграция |
| ЦКС 1С | интеграция |
| МУП ККП | интеграция |
| Форма 001 ПАО "ЧЕЛЯБИНВЕСТБАНК" | выписка |
| УК Территория (ООО "Центр Расчетов") | интеграция |
| Реммонтаж Сервис | интеграция |
| СБ 3 | выписка |