Cross River API Platform User Manual

Вземете токен за достъп: След като получите вашите API идентификационни данни и преди да можете да използвате нашите API, трябва да получите токен за достъп, използвайки client_id и client_secret сте получили при регистрацията си.

Използвайте токен за достъп: След като успешно се удостоверите, access_token се връща към вас. Включете този токен в заглавката на вашите API извиквания.

Webкукички: WebКуките са важен компонент на всяка интеграция с Cross River. Докато API-тата ви позволяват да заявявате данни при поискване, webКуките изпращат актуализации в реално време директно към вашата система, елиминирайки необходимостта от постоянно запитване и намалявайки латентността.

пясъчник среди: Пясъчникът е напълно изолирана среда, така че не се колебайте да

2.1. Получаване на API идентификационни данни

Стъпка 1
Получаване на API идентификационни данни

Стъпка 2
Вземете токен за достъп

Стъпка 3
Използвайте токен за достъп

Стъпка 4
Изградете Sample App

Първата ви стъпка към работа с Cross River API е да се регистрирате за API идентификационни данни. С тези идентификационни данни можете да заявите и получите токен за достъп, който да използвате за изпращане на API в нашата sandbox среда.

ВАЖНО

Вашият IP адрес, който трябва да е публичен и статичен, трябва да е в нашия списък с разрешени адреси. Вашият вътрешен ИТ отдел би трябвало да може да ви предостави този IP адрес. Научете повече за статичните IP адреси.

Достъп до пясъчник

Изпратете заявка за достъп до пясъчник, за получаване на API идентификационни данни.

След като вашият статичен IP адрес бъде добавен към нашия списък с разрешени потребители, ще ви изпратим 2 криптирани имейла с вашите идентификационни данни:

Един имейл съдържа вашето client_id , партньорски_идентификатор и друга информация, от която ще се нуждаете, в зависимост от това, което сте поискали.

Вторият имейл, който е криптиран, съдържа вашето client_secret и webтайна_на_куката Ще ви трябват тези данни за удостоверяване и за работа в пясъчник.

ЗАБЕЛЕЖКА

Ако сте поискали достъп до плащания с карта, ще получите допълнителен набор от идентификационни данни, включително втори client_id и client_secret

2.2. Вземете токен за достъп

Стъпка 1
Получаване на API идентификационни данни

Стъпка 2
Вземете токен за достъп

Стъпка 3

Използвайте токен за достъп

Стъпка 4
Изградете Sample App

Cross River използва OAuth 2.0 за удостоверяване и оторизация. Това контролира достъпа до нашата система и гарантира, че само оторизирани лица имат достъп до нашите API и други защитени ресурси. Информацията, която въвеждате в нашата система за удостоверяване, е поверителна и никога не може да бъде достъпна от други приложения на Cross River.

След като получите своя [име на идентификационен номер] и преди да можете да използвате нашите API, трябва да получите API идентификационни данни. токен за достъп, използващ client_id и client_secret който сте получили при регистрацията си. Този токен за достъп ви позволява да изпращате информация сигурно като JSON обект за използване в нашите API. Трябва да включите този токен в заглавката на всяка API заявка.

Има няколко начина за заявка и получаване на токен за достъп:

Използвайте интерфейса на командния ред (CLI) с cURL или който и да е друг език

Използвайте Postman или друг инструмент за тестване на API

След като го получите, копирайте токена за достъп в клипборда си. Уверете се, че сте го запазили.

Интерфейс на командния ред

За да заявите токен, изпратете POST връзка/токен команда, съдържаща client_id и client_secret и тип_грант към (сървър за удостоверяване) на сървъра за удостоверяване подходяща пясъчна кутия, както е показано в sampле по-долу.

Вижте за обяснение на тези tagsТаблица с HTTP компоненти

Следният примерampле използва cURL да поискате токен от един от сървърите за оторизация.

Sampзаявка в cURL за COS

curl –местоположение –заявка „POST https://idptest.crbcos.com/connect/token“ \ –заглавка „Тип съдържание: приложение/x-www-форма-“urlкодиран \ –данни-urlпиша с шифър 'client_id=[вашият идентификатор тук]' \

–данни-urlпиша с шифър 'client_secret=[вашата тайна тук]' \

–данни-urlпиша с шифър „grant_type=клиентски_идентификационни_данни“ \

–данни-urlпиша с шифър „аудитория=https://api.crbcos.com/“

Sampотговор от cURL искане

{ „маркер_за_достъп“: „съдържа много символи“, \

„изтича след“: 86400, \

„тип_токен“: „Носител“ }

Пощальон

За да заявите токен чрез Postman, изпратете POST връзка/токен команда към авт сървър на съответната пясъчна кутия. Добавете тип_грант , обхват (по избор) ,

client_id и client_secret към обаждането.

Вижте за обяснение на тези tagsТаблица с HTTP компоненти

Ако удостоверяването е успешно, кодът на състоянието е 200 (OK).

COSExplorer

В , щракнете върху стрелката надолу до данните за вход и щракнете върху Копиране на токен за достъпCOS Explorer

Токенът за достъп се копира в клипборда ви, готов за използване в .Sandbox.

Отговор на заявка за токен

Описание на атрибута

достъп_до

кен

Цифрово подписан JSON файл web токен (JWT), изпратен от oAuth сървъра, който позволява достъп до специфични ресурси на Cross River

обхват

Набор от услуги, до които потребителят има достъп

изтича_i

Времето до изтичане на валидността на токена.

– Нашият екип по интеграция ще ви информира за срока на валидност или можете сами да декодирате вашия токен за достъп.

– Препоръчваме ви да получите нов токен за достъп малко преди изтичането на стария токен.

– Използвайте повторно токените за целия им жизнен цикъл, вместо да получавате нов токен за всяко извикване на един и същ защитен ресурс (API).

ВАЖНО:

Никога не декодирайте токена си на публично хоствана платформа webсайт

тип токен

Токен на приносител

HTTP компоненти

Следните HTTP компоненти се използват както в API, така и в заявките на Postman.

HTTP

компонент

Tag Описание

Крайна точка	ПУБЛИКУВАНЕ /свързване/токен n	Крайна точка за извличане на токен за достъп
Заглавка	съдържание тип	приложение/x-www-form- urlкодиран
Тяло	client_id	Уникалният идентификатор за клиента
Тяло	client_secre t	Криптиран низ от знаци, използван за подписване и валидиране на идентификационни маркери. Важно: Тайните данни не могат да бъдат възстановени чрез CR. Ако загубите тайна, трябва да се генерира нова. недей предайте тайните си в контрола на изходния код.
Тяло	тип_грант	Това поле винаги ще има стойност клиентски_идентификационни_данни
Тяло	аудитория по желание	Начин, по който потребителят може да провери дали даден токен за достъп е предназначен за него.
Тяло	обхват по желание	Специфичен диапазон или ограничен набор от услуги, до които потребителят може да има достъп с токен за достъп. Ако не е посочен обхват, върнатият токен ще съдържа всички обхвати, свързани с вашите идентификационни данни. Забележка: В една и съща заявка могат да се изпращат множество обхвати, като се добави интервал между името на всеки обхват. Напримерample: 'scope=scope1 scope2 scope3'

Сървър за оторизацияURLs

Сървър за удостоверяване на модула URL

Сметки	https://idptest.crbcos.com/connect/token
ACH	https://idptest.crbcos.com/connect/token
Проводници	https://idptest.crbcos.com/connect/token
Проверки	https://idptest.crbcos.com/connect/token
Ядро	https://idptest.crbcos.com/connect/token
Незабавни плащания	https://idptest.crbcos.com/connect/token
Издаване на карта	https://idptest.crbcos.com/connect/token
Плащания с карта	https://crbcos-sandbox.auth0.com/oauth/token

Кредитиране https://oauthtest.crbnj.net/connect/token

Отстраняване на неизправности

Ако токенът за удостоверяване е валиден, ще върне код 200. Ако токенът за удостоверяване не е валиден, ще върне код 401.

Ако не можете да получите токен на приносител и не сте получавали такъв в миналото:

Потвърдете URL.

Проверете дали client_id и client_secret са въведени правилно. Те са чувствителни към малки и големи букви.

Проверете вашия client_id и client_secret спрямо полученото от вас. Уверете се, че няма проблеми с мрежата или списъка с разрешени потребители.

Свържете се с нашия екип за интеграция, ако акаунтът ви е заключен в резултат на 3 неправилни влизания. опити.

2.3. Използвайте токен за достъп

Стъпка 1
Получаване на API идентификационни данни

Стъпка 2
Вземете токен за достъп

Стъпка 3
Използвайте токен за достъп

Стъпка 4
Изградете Sample App

След като сте успешни, ще получите токен за достъп се връща при вас. Включете удостоверено този токен в заглавката на вашите API извиквания.

Токенът за достъп изтича след зададен период от време. Отговорът, съдържащ токена, също така указва времето на изтичане в секунди. Съхранявайте и използвайте вашия токен за достъп, докато той изтече. Препоръчваме ви да използвате токена, докато не получите грешка 401 за неоторизирана грешка, и след това да поискате нов токен.

ВАЖНО

1. Не изисквайте нов токен за всяка API заявка.

2. Уверете се, че сте защитили токена си. Всеки, който открадне токена ви, може да се представя за ваш клиент през целия му жизнен цикъл.

API заглавка на заявката

В заглавката на всяка API заявка включете токена за достъп, както следва:

Sampпокана за банков превод в cURL

curl –location –request 'POST https://sandbox.crbcos.com/Wires/v1/payments' –header 'Авторизация: Приносител [ВАШИЯТ ТОКЕН ТУК]' \

–заглавка „Тип съдържание: приложение/x-www-форма-“urlкодиран \

–сурови данни ‘{

„Номер на сметка“: „2255685659“,

„Код на бизнес функцията“: „CTR“,

„Номер на маршрутизиране на получателя“: „021000021“,

„бенефициентФайл“: {

„ИДкод“: „F“,

„идентификатор“: „021000021“,

„име“: „JP Morgan Chase“

„бенефициент“: {

„ИДкод“: „D“,

„идентификатор“: „123456789“,

„име“: „Питър Грифин“

„Референтен номер на бенефициента“: „XYZ123“,

„сума“: 10000,

„Цел“: „плащане“

Пощальон

За да използвате токен в Postman, отидете до Упълномощаване раздел във вашата заявка, изберете Токен на приносител като тип удостоверяване и поставете токена си в предоставеното поле. Postman автоматично ще добави Приносител префикса и токена към Токен поле.

2.4. Webкукички

WebКуките са важен компонент на всяка интеграция с Cross River. Докато API-тата ви позволяват да заявявате данни при поискване, web„hooks“ изпращат актуализации в реално време директно към вашата система, елиминирайки необходимостта от постоянно запитване и намалявайки латентността. В много случаи, webКуките са по-ефективни и надеждни от самите API, което гарантира, че приложението ви ще остане синхронизирано с критични събития като промени в акаунта, актуализации на транзакциите и резултати от обработката.

Използвайте webкуки в системите на Cross River, за да ви уведомят, когато възникнат различни събития. Събитието връща ресурсен обект, който съдържа съответните подробности за темата на всяко събитие. Пълните подробности за събитието се включват и изпращат към вашата система.

Ние използваме webкуки, за да ви информират за състоянието и да докладват за промени в транзакциите. WebКуките докладват на вашата система с известия в реално време, когато се случи събитие.

Трябва да се регистрирате чрез API, за да използвате webкуки:

Регистрирайте се за акаунти, карти и събития за плащане

Регистрирайте се за събития за картови плащания

Регистрирайте се за събития за кредитиране

2.5. пясъчник среди

Нашата пясъчна среда е напълно изолирана, така че не се колебайте да експериментирате. Когато сте готови да преминете към производствен режим, уведомете ни и ние ще ви предоставим производствени идентификационни данни за достъп до реалната среда.

Управление на клиенти