Nedladdningar

Maskinläsbara API-specifikationer och utvecklingsresurser för enklare integration.

Vad är dessa filer?

Dessa filer gör det enklare att integrera med FöretagsAPI. OpenAPI-specifikationen kan användas för att generera klientkod automatiskt, och Postman-kollektionen låter dig testa API:et direkt utan att skriva kod.

Tillgängliga filer

OpenAPI Specification (JSON)
JSON

Maskinläsbar API-definition i JSON-format. Rekommenderad för de flesta verktyg och kodgeneratorer.

OpenAPI Specification (YAML)
YAML

Samma API-specifikation i YAML-format. Mer läsbar för manuell granskning.

Postman Collection
JSON

Förberedd Postman-kollektion med alla endpoints och exempelsvar. Importera direkt till Postman för snabb testning.

Användningsexempel

OpenAPI med Swagger UI

Använd OpenAPI-specifikationen med Swagger UI för interaktiv API-dokumentation:

# Swagger Editor (online)
https://editor.swagger.io/?url=https://foretagsapi.se/openapi.json

# Lokal Swagger UI med Docker
docker run -p 8080:8080 -e SWAGGER_JSON_URL=https://foretagsapi.se/openapi.json swaggerapi/swagger-ui

Importera till Postman

Importera Postman-kollektionen för att börja testa direkt:

Öppna Postman och klicka på "Import"
Välj filen ForetagsAPI.postman_collection.json
Sätt variabeln FAPI_KEY till din API-nyckel
Börja testa endpoints!