Cross River API Platform User Manual

API-platform

Begin

1. Welkom

NUUT! Cross River-publiek met voorafgeboude versoeke vir die Cross Postman-versameling
Rivier. API-eindpunte

Welkom by Kruisrivier dokumentasie

Ontdek, verken en begin ons produkte met gemak integreer

Vinnige begin Verken alle produkte

Kry begin
Stel op en begin jou reis met behulp van Cross River API's

Konsepte
Ontdek hoe Cross River-oplossings jou fintech-reis kan transformeer

API's
Ontwikkel met behulp van die Cross River-oewer
platform en robuuste API-stelle

Tutoriale
Leer hoe om Kruis te gebruik
Rivier-API's stap vir stap

2. Vinnige begin

Stap 1
Stap 2
Stap 3
Stap 4

Kry toegangstoken

Gebruik Toegangstoken

Bou 'n Sampdie App

Kry API-geloofsbriewe: Jou eerste stap om met Cross River API's te werk, is om vir API-geloofsbriewe te registreer.

Kry toegangstoken: Sodra jy jou API-bewyse ontvang het en voordat jy ons API's kan gebruik, moet jy 'n toegangstoken kry deur die kliënt_id en kliënt_geheim wat jy ontvang het toe jy geregistreer het.

Gebruik toegangstoken: Sodra jy suksesvol geverifieer het, 'n toegang_teken word aan jou terugbesorg. Sluit hierdie teken in die koptekst van jou API-oproepe in.

Webhake: Webhake is 'n belangrike komponent van enige integrasie met Cross River. Terwyl API's jou toelaat om data op aanvraag aan te vra, webHooks stuur intydse opdaterings direk na jou stelsel – wat die behoefte aan konstante polling uitskakel en latensie verminder.

Sandput-omgewings: Die sandput is 'n heeltemal geïsoleerde omgewing, so voel vry om

2.1. Kry API-geloofsbriewe

Stap 1
Kry API-geloofsbriewe

Stap 2
Kry toegangstoken

Stap 3
Gebruik Toegangstoken

Stap 4
Bou 'n Sampdie App

Jou eerste stap om met Cross River API's te werk, is om vir API-geloofsbriewe te registreer. Met hierdie geloofsbriewe kan jy 'n toegangstoken aanvra en ontvang om te gebruik vir die stuur van API's in ons sandput-omgewing.

BELANGRIK

Jou IP-adres, wat publiek en staties moet wees, moet op ons toelaatlys wees. Jou interne IT-afdeling behoort jou van hierdie IP te kan voorsien. Leer meer oor statiese IP's.

SandboxToegang

Dien 'n versoek in vir sandputtoegang, om API-geloofsbriewe te ontvang.

Sodra jou statiese IP-adres by ons toelaatlys gevoeg is, sal ons vir jou 2 geïnkripteerde e-posse met jou geloofsbriewe stuur:

Een e-pos bevat jou kliënt_id , vennoot_id en ander inligting wat u benodig, afhangende van wat u versoek het.

Die tweede e-pos, wat geïnkripteer is, bevat jou kliënt_geheim en webhaak_geheim Jy sal dit nodig hê vir verifikasie en om in die sandput te werk.

LET WEL

As jy toegang tot Kaartbetalings versoek het, sal jy 'n bykomende stel geloofsbriewe ontvang, insluitend 'n tweede kliënt_id en kliënt_geheim

2.2. Kry toegangstoken

Stap 1
Kry API-geloofsbriewe

Stap 2
Kry toegangstoken

Stap 3

Gebruik Toegangstoken

Stap 4
Bou 'n Sampdie App

Cross River gebruik OAuth 2.0 vir verifikasie en magtiging. Dit beheer toegang tot ons stelsel en verseker dat slegs gemagtigde entiteite toegang tot ons API's en ander beskermde hulpbronne kan kry. Die inligting wat u in ons verifikasiestelsel invoer, is vertroulik en kan nooit vanaf enige ander Cross River-toepassings verkry word nie.

Sodra jy jou [naam] ontvang het, en voordat jy ons API's kan gebruik, moet jy API-geloofsbriewe kry. 'n toegangstoken met behulp van die kliënt_id en kliënt_geheim wat jy ontvang het toe jy geregistreer het. Hierdie toegangstoken laat jou toe om inligting veilig as 'n JSON-objek te stuur vir gebruik in ons API's. Jy moet hierdie token in die koptekst van elke API-versoek insluit.

Daar is verskeie maniere om 'n toegangstoken aan te vra en te ontvang:

Gebruik die opdragreël-koppelvlak (CLI) met cURL of enige ander taal

Gebruik Postman of enige ander API-toetsinstrument

Sodra dit verkry is, kopieer die toegangstoken na jou knipbord. Maak seker dat jy dit stoor.

Opdragreëlkoppelvlak

Om 'n teken aan te vra, stuur 'n POST-verbinding/token opdrag wat die kliënt_id en kliënt_geheim en toekenningstipe na die (outentiseringsbediener) van die outentiseringsbediener toepaslike sandput, soos getoon in die sample hieronder.

Verwys na die vir 'n verduideliking hiervan tags. HTTP-komponente tabel

Die volgende example gebruike cURL om 'n teken van een van die outentiseringsbedieners aan te vra.

Sampdie versoek in cURL vir COS

curl –ligging –versoek 'POST https://idptest.crbcos.com/connect/token' \ –koptekst 'Inhoudtipe: toepassing/x-www-vorm-urlgeënkodeer \ –data-urlenkodeer 'kliënt_id=[jou id hier]' \

–data-urlenkodeer 'kliënt_geheim=[jou geheim hier]' \

–data-urlenkodeer 'toelaagtipe=kliënt_bewyse' \

–data-urlenkodeer 'gehoor=https://api.crbcos.com/'

Sampdie reaksie van cURL versoek

{ "toegangstoken": "bevat baie karakters", \

"verval_in": 86400, \

"token_tipe": "Draer" }

Posman

Om 'n teken met Postman aan te vra, stuur 'n POST-verbinding/token bevel aan die auth bediener van die toepaslike sandput. Voeg die toekenningstipe , omvang (opsioneel) ,

kliënt_id en kliënt_geheim na die oproep.

Verwys na die vir 'n verduideliking hiervan tags. HTTP-komponente tabel

Indien die verifikasie suksesvol is, is die statuskode 200 (OK).

COSExplorer

In , klik die pyltjie af langs jou aanmelding en klik Kopieer ToegangstokenCOS Verkenner

Die toegangstoken word na jou knipbord gekopieer, gereed vir gebruik in die . Sandbox

Reaksie op tekenversoek

Attribuutbeskrywing

toegang_tot

ken

'n Digitaal getekende JSON web teken (JWT) gestuur vanaf die oAuth-bediener wat toegang tot spesifieke Cross River-hulpbronne toelaat

omvang

'n Reeks dienste waartoe 'n gebruiker toegang kan kry

verval_i

Die hoeveelheid tyd totdat die teken verval.

– Ons Integrasiespan sal jou inlig oor die vervaldatum of jy kan ook jou toegangstoken dekodeer.

– Ons beveel aan dat u 'n nuwe toegangstoken kry kort voor die ou token verval.

– Hergebruik tokens vir hul hele lewensduur eerder as om 'n nuwe token te kry vir elke oproep na dieselfde beskermde hulpbron (API).

BELANGRIK:

Moet nooit jou teken op 'n publiek aangebiedde platform dekodeer nie. webwebwerf

tekentipe

Draerteken

HTTP-komponente

Die volgende HTTP-komponente word in beide die API- en Postman-versoeke gebruik.

HTTP

komponent

Tag Beskrywing

Eindpunt	POS /konnekteer/toke n	Eindpunt vir die herwinning van 'n toegangstoken
Opskrif	inhoud tipe	aansoek/x-www-vorm- urlgeënkodeer
Liggaam	kliënt_id	Die unieke identifiseerder vir 'n kliënt
Liggaam	kliënt_geheim t	'n Geënkripteerde string karakters wat gebruik word om ID-tokens te teken en te valideer. Belangrik: Geheime kan nie deur CR herwin word nie. As jy 'n geheim verloor, moet 'n nuwe een gegenereer word. Moenie vertrou jou geheime toe aan bronbeheer.
Liggaam	toekenningstipe	Hierdie veld sal altyd 'n waarde hê van kliënt_bewyse
Liggaam	gehoor opsioneel	'n Manier vir die gebruiker om te bevestig of 'n spesifieke toegangstoken vir hulle bedoel is.
Liggaam	omvang opsioneel	'n Spesifieke reeks of 'n beperkte stel dienste waartoe 'n gebruiker toegang kan verkry met 'n toegangstoken. Indien 'n omvang nie gespesifiseer word nie, sal die terugbesorgde teken alle omvange bevat wat met jou geloofsbriewe geassosieer word. Let wel: Verskeie omvangsgebiede kan in dieselfde versoek gestuur word deur 'n spasie tussen die naam van elke omvang by te voeg. Byvoorbeeldample: 'scope=scope1 scope2 scope3'

MagtigingsbedienerURLs

Module-magtigingsbediener URL

Rekeninge	https://idptest.crbcos.com/connect/token
ACH	https://idptest.crbcos.com/connect/token
Drade	https://idptest.crbcos.com/connect/token
Tjeks	https://idptest.crbcos.com/connect/token
Kern	https://idptest.crbcos.com/connect/token
Kitsbetalings	https://idptest.crbcos.com/connect/token
Kaartuitreiking	https://idptest.crbcos.com/connect/token
Kaartbetalings	https://crbcos-sandbox.auth0.com/oauth/token

Uitleen https://oauthtest.crbnj.net/connect/token

Probleemoplossing

Indien die verifikasieteken geldig is, sal dit 'n 200 terugstuur. Indien die verifikasieteken nie geldig is nie, sal dit 'n 401 terugstuur.

As jy nie 'n draerteken kan kry nie en jy het nog nie een in die verlede ontvang nie:

Bevestig die URL.

Kontroleer dat die kliënt_id en kliënt_geheim korrek getik is. Hulle is hooflettergevoelig.

Gaan jou kliënt_id en kliënt_geheim teenoor die een wat jy ontvang het. Maak seker daar is geen netwerk- of toelaatlysprobleme nie.

Kontak ons Integrasiespan indien u rekening gesluit is as gevolg van 3 verkeerde aanmeldings. pogings.

2.3. Gebruik toegangstoken

Stap 1
Kry API-geloofsbriewe

Stap 2
Kry toegangstoken

Stap 3
Gebruik Toegangstoken

Stap 4
Bou 'n Sampdie App

Sodra jy suksesvol is, 'n toegangstoken word aan jou terugbesorg. Sluit geverifieerde hierdie teken in die koptekst van jou API-oproepe.

Die toegangstoken verval na 'n vasgestelde tydperk. Die antwoord wat die token bevat, spesifiseer ook die vervaltyd in sekondes. Stoor en gebruik jou toegangstoken totdat dit verval. Ons beveel aan dat jy die token gebruik totdat jy 'n 401 ongemagtigde fout ontvang, en dan 'n nuwe token aanvra.

BELANGRIK

1. Moenie 'n nuwe token vir elke API-versoek aanvra nie.

2. Maak seker dat jy jou teken beskerm. Enigiemand wat jou teken steel, kan jou kliënt vir die leeftyd van die teken naboots.

API-versoekopskrif

In die opskrif van elke API-versoek, sluit die toegangstoken soos volg in:

Sample oproep vir elektroniese betaling in cURL

curl –ligging –versoek 'POST https://sandbox.crbcos.com/Wires/v1/payments' –koptekst 'Magtiging: Draer [JOU TOKEN HIER]' \

–koptekst 'Inhoudtipe: toepassing/x-www-vorm-urlgeënkodeer \

–data-rou ‘{

“rekeningnommer”: “2255685659”,

“besigheidsfunksiekode”: “Klikkliektempo”,

“ontvangerRoeteringsnommer”: “021000021”,

“begunstigdeFi”: {

“IDKode”: “F”,

“identifiseerder”: “021000021”,

“naam”: “JP Morgan Chase”

"begunstigde": {

“IDKode”: “D”,

“identifiseerder”: “123456789”,

“naam”: “Peter Griffin”

“begunstigdeverwysing”: “XYZ123”,

"bedrag": 10000,

“doel”: “betaling”

Posman

Om 'n teken in Postman te gebruik, navigeer na die Magtiging oortjie in jou versoek, kies Draerteken as die verifikasietipe, en plak jou teken in die voorsiene veld. Postman sal outomaties die Draer voorvoegsel en die teken aan die Teken veld.

2.4. Webhake

Webhake is 'n belangrike komponent van enige integrasie met Cross River. Terwyl API's jou toelaat om data op aanvraag aan te vra, webhake stuur intydse opdaterings direk na jou stelsel, wat die behoefte aan konstante polling uitskakel en latensie verminder. In baie gevalle, webHooks is meer doeltreffend en betroubaar as API's alleen, wat verseker dat jou toepassing gesinchroniseer bly met kritieke gebeurtenisse soos rekeningveranderinge, transaksieopdaterings en verwerkingsuitkomste.

Gebruik webhake binne die Cross River-stelsels om jou in kennis te stel wanneer verskillende gebeurtenisse plaasvind. Die gebeurtenis stuur 'n hulpbronobjek terug wat relevante besonderhede oor die onderwerp van elke gebeurtenis bevat. Die volledige gebeurtenisbesonderhede word ingesluit en na jou stelsel gestuur.

Ons gebruik webhake om jou op hoogte te hou van status en om transaksieveranderinge te rapporteer. WebHooks rapporteer aan jou stelsel met intydse kennisgewings wanneer 'n gebeurtenis plaasvind.

Jy moet via API registreer om te gebruik webhake:

Registreer vir rekeninge, kaarte en betalingsgebeurtenisse

Registreer vir kaartbetalingsgeleenthede

Registreer vir Uitleengeleenthede

2.5. Sandput-omgewings

Ons sandput is 'n heeltemal geïsoleerde omgewing, so voel vry om te eksperimenteer. Wanneer jy gereed is om na produksie oor te skakel, laat weet ons en ons sal vir jou produksiebewyse kry om toegang tot die lewendige omgewing te verkry.

Kliëntebestuur