Loam Customer API · Mwonekano wa awali

Kituo cha Waendelezaji

Anza hapa kujenga juu ya Loam Customer API.

Dakika tano Mwongozo wa haraka Anza na mteja mpya wa API hadi kupata jibu la moja kwa moja: tengeneza tokeni, soma salio zilizolipishwa, kisha omba nukuu ya ubadilishaji wa fedha za kigeni. Mtiririko wa soko unajumuishwa pale uwezo huo unapowezeshwa. Fuata mwongozo wa haraka OpenAPI 3.1 Rejea ya API Soma mkataba uliotangazwa endpoint kwa endpoint — kila scope, schema ya ombi na ya jibu, na misimbo ya makosa, pamoja na mtengenezaji wa maombi kwa kila njia. Fungua rejea ya API

Njia zote zinahitaji vitambulisho. Anza kwa kuunda mteja wa API.

Nukuu ya kwanza

Uandishi mmoja kwa HTTPS kwa tokeni ya bearer na ufunguo wa idempotency. Nukuu inashikilia kiwango cha mtoa huduma — 10,000 USD vitengo vidogo kwa 9,125 EUR katika mfano — na haitahamishi fedha.

POST /api/v1/fx/quotes
curl --fail-with-body --silent --show-error \  --request POST "$LOAM_API_BASE/fx/quotes" \  --header "Authorization: Bearer $LOAM_TOKEN" \  --header "Content-Type: application/json" \  --header "Idempotency-Key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \  --data '{"from_currency":"USD","to_currency":"EUR","amount":10000}'// Response
HTTP/1.1 202 Accepted
Location: /api/v1/fx/quotes/a6bbdbeb-ed3b-42cb-85b1-af3112f2fe06

{
  "ok": true,
  "data": {
    "id": "a6bbdbeb-ed3b-42cb-85b1-af3112f2fe06",
    "from_amount": 10000,
    "from_currency": "USD",
    "to_amount": 9125,
    "to_currency": "EUR",
    "rate_decimal": "0.9125",
    "fee_amount": -25,
    "fee_currency": "USD",
    "expires_at": "2099-08-14T16:35:00.000Z",
    "state": "active"
  }
}

Nini API inafunika leo

Ufikiaji wa mwonekano wa awali umebana kwa makusudi kuliko mkataba uliotangazwa. Kila kitu hapa chini kinapatikana sasa au kinaonyesha ruhusa inayosubiriwa.

Fungua katika mwonekano wa awali Skopu read na write

  • Salio zilizolipwa GET /api/v1/balances
  • Masharti ya ghala la hazina GET /api/v1/vaults
  • Nukuu za ubadilishaji wa fedha za kigeni POST /api/v1/fx/quotes

Imefungwa katika mwonekano wa awali Skopu money.write

  • Malipo kwa anwani iliyothibitishwa POST /api/v1/payments
  • Fedha zinazoingia kutoka akaunti ya benki POST /api/v1/onramp
  • Fedha zinazotoka kwenda akaunti ya benki POST /api/v1/offramp
  • Amana na uondoaji kwenye ghala la hazina POST /api/v1/vaults/…

Harakati za fedha zinahitaji mmiliki wa shirika wa kibinadamu kutoa skopu chini ya uthibitisho wa hatua-juu, kuweka kikomo kwa kila muamala, na kuidhinisha mpokeaji mapema. Endpoints hizo zitaendelea kufungwa hadi mwonekano wa awali uishe.

Jinsi API inavyofanya kazi

  • OAuth 2.0

    Ruzuku ya vitambulisho vya mteja

    Badilisha client id na secret kwa tokeni ya bearer ya muda mfupi kwa ombi moja la form-encoded. Skopu husomwa kutoka kwa mteja kwa kila ombi, hivyo kupunguza skopu moja hufanyika mara moja.

  • Kifurushi

    Muundo mmoja kwa kila njia

    Mafanikio ni ok kisha data; kushindwa ni ok: false na msimbo wa kosa unaosomwa na mashine.

  • Idempotency

    Majaribio ya kurudia hayagharimu chochote

    Kila uandishi unahitaji Idempotency-Key. Ufunguo ule ule ukiwa na mwili ule ule hurudia matokeo ya kwanza badala ya kuandika mara mbili.

  • Upangaji kwa kurasa

    Cursors, sio offsets

    Njia za orodha hurudisha page.next_cursor. Uitumie tena kama cursor hadi itakaporejea null.

Chagua njia kutoka hapa: mwongozo wa haraka ikiwa unataka kuwa na ombi linalofanya kazi mara moja, rejea ikiwa tayari unajua wito unaohitaji.

Fuata mwongozo wa haraka Fungua marejeo ya API