Översikt av API:et

Gör ditt första anrop#

1. Skapa en läsnyckel

   Öppna Admin → Integrations i portalen och skapa en integration med rollen Viewer. Skapa sedan en nyckel med omfattningen read och kopiera den när den visas. Läs mer under Autentisering.

2. Lista era lager

   Kör kommandot nedan på din dator eller server och byt ut YOUR_API_KEY mot din nyckel. Svarets lista collections innehåller de lager som integrationen får läsa.

export ORBGIS_API_KEY="YOUR_API_KEY"
curl --fail-with-body \
  -H "Authorization: Bearer $ORBGIS_API_KEY" \
  "https://api.orbgis.se/v1/collections?limit=10"

Kopiera ett lagers id och anropa /v1/collections/{id}/items?limit=10 med samma header för att läsa objekten. En samling, collection, motsvarar ett lager. Dess UUID skiljer sig från datasetets innehålls-id.

Välj det du vill göra#

I API-referensen finns parametrar och svarsfält för varje endpoint. OpenAPI-dokumentet kan importeras i Postman, Insomnia eller en SDK-generator.

Åtkomst och fel#

• Skicka integrationsnyckeln eller en användares åtkomsttoken i Authorization: Bearer …. Förvara nycklar på servern. Publicerat innehåll kan läsas utan inloggningsuppgifter.
• Fel returneras som application/problem+json med en maskinläsbar code. Använd X-Request-Id för att koppla anrop till loggar; API:et skickar tillbaka ett giltigt id eller skapar ett.
• Ett 429-svar innehåller Retry-After. Headers X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset visar hur mycket som återstår av den aktuella anropsgränsen.

Gränser#

Hämta objektsidor i följd. Vid 429 too_many_concurrent väntar du så länge som Retry-After anger innan du försöker igen. Använd export för större nedladdningar.

Versioner#

Versionen anges i sökvägen. Inom /v1 kan nya endpoints, valfria parametrar och svarsfält tillkomma. Ändringar som bryter befintliga integrationer kräver /v2; den gamla versionen finns kvar i minst tolv månader och slutdatumet meddelas med Deprecation och Sunset.