Начало работы
Что нужно для первого запроса к API и что API умеет сегодня.
Target принимает платежи мерчанта и ведёт их к платёжным провайдерам. С API работает сервер мерчанта. Документация описывает только то, что выпущено.
Что нужно знать сразу
- Адрес API один для тестового и боевого контура:
https://api.thetarget.cc. Все ручки начинаются с/api/v1. Только HTTPS. - API вызывается с сервера. Заголовков CORS нет намеренно: ключ API не должен попадать в код страницы или приложения.
- Запросы и ответы в JSON, кодировка UTF-8.
- Каждый запрос несёт ключ API. Ключ определяет мерчанта и контур.
- Суммы это целые числа минорных единиц валюты, записанные строкой.
- У каждого ответа есть номер запроса для обращения в поддержку.
Первый запрос
- Получите тестовый ключ у администратора Target. Как устроен ключ и где его выдают: Авторизация.
Положите ключ в переменную окружения на своём сервере. В командах документации ключ берётся оттуда.
export TARGET_API_KEY='ключ, который вам выдали'Проверьте ключ:
curl -sS https://api.thetarget.cc/api/v1/me \ -H "Authorization: Bearer $TARGET_API_KEY"В ответ придут мерчант, контур и открытая часть ключа: поля и пример ответа. Если пришёл отказ, его причина названа в теле: Формат ошибок.
Что API умеет сегодня
| Метод | Адрес | Что делает |
|---|---|---|
| GET | /api/v1/me | Проверить ключ |
| GET | /api/v1/services | Список сервисов |
| POST | /api/v1/payments | Создать платёж |
| GET | /api/v1/payments | Найти платёж по номеру заказа |
| GET | /api/v1/payments/:id | Прочитать платёж |
| POST | /api/v1/payments/:id/refunds | Создать возврат |
| GET | /api/v1/payments/:id/refunds | Возвраты платежа |
| GET | /api/v1/payments/:id/refunds/:refundId | Прочитать возврат |
| POST | /api/v1/payouts | Завести выплату |
| GET | /api/v1/payouts/:id | Прочитать выплату |
| POST | /api/v1/payouts/:id/cancel | Отменить выплату |
| POST | /api/v1/notifications/secret | Выпустить секрет подписи уведомлений |
Платёж создаётся одним запросом, плательщик платит на странице оплаты или в вашей форме, исход приходит уведомлением или узнаётся чтением. Успешный платёж можно вернуть. Порядок работы: Приём платежа. Боевой приём закрыт, платежи принимает тестовый контур. Ручка появляется в справочнике и в журнале изменений в день выпуска, не раньше.