Скип на основной контент

аутентификация

4pay.online Поддерживает два метода аутентификации партнера API доступ.


Передай. API Ключ в том x-api-key Запросить заголовок, Вместе с тем x-organization-idДва заголовка, а не один: ключ решается внутри организация имен заголовков, а запрос, содержащий только ключ, отклоняется; Перед тем, как ключ прочитают. Относитесь к обоим 400 и 401 как "эти полномочия" не используются: некоторые конечные точки отвечают на недостающий заголовок организации голый 400 Bad Request Вместо того, чтобы 401Ваш оператор дает вам оба значения. Это самый простой и распространенный метод для сервера-сервера. Интеграция.

curl https://4pay.online/api/v1/transactions \
-H "x-api-key: pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "x-organization-id: 00000000-1111-2222-3333-444444444444"

Где найти свой API Ключ:

  1. Войти внутрь Партнерская зона
  2. Go to Настройки → API Ключи
  3. щелкнуть Создать ключ — скопируйте значение сразу, оно отображается только один раз
Сохрани свой API Ключевой секрет

Магазин API ключи в переменных окружающей среды. Никогда не связывайте их с исходным кодом или не включайте в код на стороне клиента.


метод 2 Bearer Token (сессионный)​

Для интерактивных приложений вы можете аутентифицировать с помощью логина / пароля, чтобы получить токен Bearer.

Создайте сессию​

curl -X POST https://4pay.online/api/v1/session \
-H "Content-Type: application/json" \
-d '{
"type": "partner",
"login": "your-login",
"password": "your-password"
}'

Ответ:

{
"token": "b7f0c9d2-1e4a-4c8b-9f31-2a5d6e7c8b90",
"refresh_token": "1acdd2f3-299a-4213-a2df-39b6fae4d165",
"inserted_at": 1788434490,
"expire_at": 1789039290
}
Поле истечения срока

It is expire_at - единственного, и Unix секундыНе в одном ISO 8601 Код, написанный против an expires_at временная метка читать undefined И как бы он ни был бессмертен, он начинает терпеть неудачу. Неделю спустя без видимой причины. Сессия длится семь дней.

Используйте токен​

curl https://4pay.online/api/v1/transactions \
-H "Authorization: Bearer eyJhbGci..."

Обновить сессию​

curl -X PUT https://4pay.online/api/v1/session \
-H "Content-Type: application/json" \
-d '{
"refresh_token": "1acdd2f3-299a-4213-a2df-39b6fae4d165"
}'

Завершить сессию​

curl -X DELETE https://4pay.online/api/v1/session \
-H "Authorization: Bearer eyJhbGci..."

сопоставление​

API КлючТокен-носитель
НастройкаОдноразовый, без истечения срокаЛогин требуется для каждой сессии
Лучшее дляИнтеграция сервер-серверИнтерактивные / приборные панели приложений
Заголовокx-api-key: YOUR_KEYAuthorization: Bearer TOKEN
аннулированиеУдалить ключ в партнерской зонеDELETE /session или Ключевое истечение

HTTP Коды ответов​

КодЗначение
200Успех
201Ресурс, созданный - не доказательство того, что платеж был принят; читать status
400Плохая просьба — неправильно сформированное тело или пропавшее без вести x-organization-id
401Несанкционированные — недостающие или недействительные учетные данные
403Запрещенные — действительные полномочия, но недостаточные разрешения
422Ошибка проверки — проверьте errors Поле в ответе
429Ограниченная скорость — замедляйте запросы
500Внутренняя ошибка сервера — поддержка контактов