API reference

API Reference je autoritativní kontrakt pro Swipelux API. Každá operace ukazuje své schéma požadavku, odpovědi, zabezpečení, stavu a chyb. Pro každý požadavek používejte https://platform.swipelux.com. Odesílejte klíč specifický pro vaše prostředí v X-API-Key z chráněného backendu.

Zajistěte bezpečné opakování zápisů

Když operace uvádí Idempotency-Key jako povinný, vygenerujte jeden klíč pro každou zamýšlenou operaci a uložte jej se svým lokálním záznamem požadavku.

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"}'

Pokud je odpověď nejistá, opakujte identickou metodu, cestu a tělo se stejným klíčem. Nepoužívejte tento klíč znovu pro jinou operaci nebo změněné tělo. Některé operace vrací Idempotency-Replayed: true, když odpověď pocházela z dřívějšího požadavku se stejným klíčem. Považujte tuto odpověď za výsledek původní operace, nikoli za druhou operaci.

Zpracování chyb

Chyby API používají application/problem+json. Postavte chování klienta na těchto stabilních polích:

Pole	Použití
`status`	HTTP status spojený s problémem.
`code`	Stabilní strojově čitelný kód chyby.
`detail`	Použitelné vysvětlení pro aktuální požadavek.
`retryable`	Zda opakování stejného požadavku může uspět, pokud je uvedeno.
`errors[].pointer`	JSON Pointer na neplatné pole požadavku.
`correlationId`	Identifikátor požadavku pro uchování v logech a záznamech podpory.

correlationId v odpovědi odpovídá X-Request-Id. Zaznamenávejte operaci i tuto hodnotu, ale neodhalujte tajemství ani úplné finanční detaily.

{
  "type": "https://docs.swipelux.com/problems/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."
    }
  ]
}

Použijte zdokumentovaná schémata problémů dané operace k rozhodnutí, zda opravit vstup, obnovit stav zdroje, dokončit úkol nebo opakovat. Kompletní katalog stavů a chyb držte v API Reference místo napevno kódovaných nezdokumentovaných případů.

Sledování asynchronních operací

Úspěšná odpověď na vytvoření spustí mnoho workflow; nezaručuje dokončení. Ukládejte ID zdrojů odvozená z odpovědi, čtěte aktuální zdroj a používejte ověřené webhooky k reakci na změny. Začněte s POST /v3/customers nebo pokračujte podle rychlého startu pro kompletní sandboxovou cestu.

Přehled

Verzování

Zajistěte bezpečné opakování zápisů

Zpracování chyb

Sledování asynchronních operací

​Zajistěte bezpečné opakování zápisů

​Zpracování chyb

​Sledování asynchronních operací

Zajistěte bezpečné opakování zápisů

Zpracování chyb

Sledování asynchronních operací