> ## Documentation Index
> Fetch the complete documentation index at: https://docs.swipelux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API-referenssi

> Käytä API-sopimusta, uudelleenyritä kirjoituksia turvallisesti ja käsittele virheitä johdonmukaisesti.

API-referenssi on Swipelux API:n arvovaltainen sopimus. Kukin toiminto näyttää pyyntönsä, vastauksensa, tietoturvan, tilan ja virheskeemat.

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.

```bash theme={null}
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.

```json theme={null}
{
  "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."
    }
  ]
}
```

Käytä toiminnon dokumentoituja ongelmaskeemoja päättääksesi, korjataanko syöte, päivitetäänkö resurssin tila, suoritetaanko tehtävä vai uudelleenyritetäänkö. Säilytä täydellinen tila- ja virheluettelo API-referenssissä sen sijaan, että koodaat dokumentoimattomia tapauksia kovakoodatusti.

## 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](/fi/integration/webhooks) reagoidaksesi muutoksiin.

Aloita [`POST /v3/customers`](/api-reference/customers/post-v3-customers) -toiminnolla tai seuraa [pikaopasta](/fi/integration/quickstart) täydelliseen sandbox-matkaan.


## Related topics

- [Integraation yleiskuvaus](/fi/integration/overview.md)
- [Yksityishenkilön käyttöönoton API-työnkulku](/fi/knowledge-base/individual-onboarding/api-workflow.md)
- [Pikaopas](/fi/integration/quickstart.md)
- [Todennus](/fi/integration/authentication.md)
- [Sandbox-testaus](/fi/integration/sandbox.md)