Utsteder-API: kom i gang

Åpne diagrammet i full størrelse.

Før du begynner

En administrator må ha opprettet utstederprofilen og koblet den til et Paradym-prosjekt. Deretter trenger du:

1. en bevismal med stabil templateSlug
2. en Symfoni-API-nøkkel; den vises bare én gang
3. testdata som følger feltene og datatypene i malen

Hold API-nøkkelen på serveren. Ikke legg den i nettleser, mobilapp eller URL.

1. Opprett et tilbud

POST /api/issuers/{issuerSlug}/credentials/{templateSlug}/issue
Authorization: Bearer <symfoniApiKey>
Content-Type: application/json

curl -X POST "https://www.symfoni.dev/api/issuers/brreg/credentials/euwoid/issue?offerUrlFormat=symfoni" 
  -H "Authorization: Bearer $SYMFONI_API_KEY" 
  -H "Content-Type: application/json" 
  -d '{
    "attributes": {
      "organizationnumber": "999888777",
      "legalname": "Eksempelvirksomheten AS"
    }
  }'

Feltnavnene er malavhengige. Eksempelet er ikke en generell EBWOID-regelbok.

2. Lagre svaret

{
  "issuanceId": "9357a8ce-f1c5-4d2d-b0d9-f20dd80fd770",
  "offerUri": "https://www.symfoni.dev/app/credential/offer?credential_offer_uri=...",
  "status": "offered",
  "templateSlug": "euwoid",
  "offerUrlFormat": "symfoni"
}

Send offerUri til riktig mottaker gjennom en avtalt kanal. Lagre issuanceId som teknisk korrelasjonsnøkkel.

3. Følg status

GET /api/issuers/{issuerSlug}/issuances/{issuanceId}
Authorization: Bearer <symfoniApiKey>

Ikke behandle offered som et ferdig utstedt bevis. Les den returnerte statusen og sett et tidsavgrenset pollingsintervall i eget fagsystem.

4. Tilbakekall ved behov

POST /api/issuers/{issuerSlug}/issuances/{issuanceId}/revoke
Authorization: Bearer <symfoniApiKey>

Tilbakekalling virker først etter at et bevis er utstedt. Gjentatte eller umulige kall gir en kontrollert feil.

Feil du må håndtere

• 400 for ugyldig JSON, feil felt, datatype eller umulig tilbakekalling
• 401 eller 403 for manglende, ugyldig eller utilstrekkelig API-nøkkel
• 404 når profil, mal eller utstedelse ikke finnes for denne klienten
• 409 når konfigurasjonen endres mens tilbudet opprettes
• 500 ved uventet avhengighets- eller systemfeil

Bruk egen request-id og idempotenslogikk rundt kallene. Det offentlige /openapi.json beskriver foreløpig docs-API-et, ikke denne utstederkontrakten.