API-referenssi

API-referenssi on Swipelux API:n arvovaltainen sopimus. Kukin toiminto näyttää pyyntönsä, vastauksensa, tietoturvan, tilan ja virheskeemat. Käytä Virheet ja uudelleenyritykset -sivua täydelliseen julkiseen ongelmaluetteloon ja ratkaisuohjeisiin. Käytä https://platform.swipelux.com jokaisessa pyynnössä. Lähetä ympäristökohtainen avaimesi X-API-Key-otsakkeessa suojatusta taustapalvelusta.

Tee kirjoituksista turvallisia uudelleenyrittää

Kun toiminto listaa Idempotency-Key-otsakkeen pakollisena, luo yksi avain kutakin aiottua toimintoa varten ja tallenna se paikallisen pyyntötietueesi kanssa.

Idempotent request

curl --request POST \
  'https://platform.swipelux.com/v3/customers' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Idempotency-Key: customer-order-1001' \
  --header 'Content-Type: application/json' \
  --data '{"type":"individual","externalId":"customer-order-1001"}'

Jos vastaus on epävarma, uudelleenyritä sama menetelmä, polku ja runko samalla avaimella. Älä käytä samaa avainta eri toimintoon tai muutettuun runkoon. Jotkin toiminnot palauttavat Idempotency-Replayed: true, kun vastaus tuli aiemmasta pyynnöstä samalla avaimella. Käsittele kyseinen vastaus alkuperäisen toiminnon tuloksena, älä toisena toimintona.

Käsittele virheitä

API-virheet käyttävät application/problem+json -muotoa. Rakenna asiakaskäyttäytyminen näiden vakaiden kenttien ympärille:

Kenttä	Käyttö
`status`	Ongelmaan liittyvä HTTP-tila.
`code`	Vakaa koneluettava virhekoodi.
`detail`	Toimintakelpoinen selitys nykyiselle pyynnölle.
`retryable`	Ilmoittaa, voiko saman pyynnön uudelleenyritys onnistua, kun se on saatavilla.
`errors[].pointer`	JSON Pointer virheelliseen pyyntökenttään.
`correlationId`	Pyynnön tunniste, joka säilytetään lokeissa ja tukitietueissa.

Vastauksen correlationId peilaa X-Request-Id-otsaketta. Kirjaa sekä toiminto että tämä arvo, mutta älä paljasta salaisuuksia tai täydellisiä taloustietoja.

Problem response

{
  "type": "https://docs.swipelux.com/errors/validation-error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "The request contains invalid fields.",
  "correlationId": "01JERRORVALIDATION",
  "errors": [
    {
      "pointer": "/externalId",
      "code": "invalid_format",
      "message": "Use a valid external identifier."
    }
  ]
}

Käytä toiminnon dokumentoituja ongelmaskeemoja päättääksesi, korjataanko syöte, päivitetäänkö resurssin tila, suoritetaanko tehtävä vai uudelleenyritetäänkö. Katso Virheet ja uudelleenyritykset jokaista julkista code-arvoa, vakaata ongelmatyypin URI:a, uudelleenyrityskäyttäytymistä ja seuraavaa toimenpidettä varten.

Seuraa asynkronisia toimintoja

Onnistunut luontivastaus käynnistää monia työnkulkuja; se ei takaa valmistumista. Tallenna vastauksesta johdetut resurssien tunnisteet, lue nykyinen resurssi ja käytä vahvistettuja webhookkeja reagoidaksesi muutoksiin. Aloita POST /v3/customers -toiminnolla tai seuraa pikaopasta täydelliseen sandbox-matkaan.

Yleiskatsaus

Versiointi

Tee kirjoituksista turvallisia uudelleenyrittää

Käsittele virheitä

Seuraa asynkronisia toimintoja

​Tee kirjoituksista turvallisia uudelleenyrittää

​Käsittele virheitä

​Seuraa asynkronisia toimintoja

Tee kirjoituksista turvallisia uudelleenyrittää

Käsittele virheitä

Seuraa asynkronisia toimintoja