Начало работы с Platega API

1. Введение

Platega API позволяет интегрировать платёжные функции в ваши сервисы: создавать платежи, проверять их статус, оформлять возвраты и получать отчёты.

Все запросы выполняются в формате JSON по протоколу HTTPS.

Базовый URL

https://app.platega.io/

2. Авторизация

Каждый запрос к API подписывается двумя заголовками:

Заголовок	Значение	Описание
`X-MerchantId`	`<Ваш MerchantId>`	идентификатор вашего магазина
`X-Secret`	`<Ваш API-ключ>`	секретный ключ, не передавайте его на клиент

⚙️ Эти данные выдаёт менеджер при подключении. Они же доступны в личном кабинете на странице Настройки.

Пример запроса

Если ключ неверен

Запрос отклоняется с кодом 401 и телом стандартного формата:

{
  "code": "Auth:GEN_1001",
  "type": 4002,
  "message": "Access denied.",
  "data": [],
  "traceId": "af95e45f8c350d4211ac5c7b6d2e1f04"
}

Поле traceId стоит сохранять в логах: по нему поддержка найдёт конкретный запрос.

3. Формат ошибок

Все ошибки API приходят в одном формате:

Поле	Тип	Описание
`code`	string	код причины отказа
`type`	integer	тип ошибки
`message`	string	текстовое пояснение
`data`	array	уточнения: какое поле не прошло проверку и почему
`traceId`	string	идентификатор запроса

4. Выводы средств

У Payout API своя схема авторизации — запросы подписываются секретным ключом по HMAC-SHA256 и заголовком Authorization: PG-HMAC, а X-MerchantId и X-Secret там не используются. Порядок подключения и формирования подписи описан в разделе Выводы.

5. Уведомления о статусах

Об изменениях статуса платежа Platega сообщает сама — POST-запросом на ваш URL. Формат тела, требования к адресу, повторные попытки и список статусов описаны в разделе Callbacks.

Авторизация

Начало работы с Platega API#

1. Введение#

2. Авторизация#

3. Формат ошибок#