API-dokumentation

Detta är dokumentationen för de tillgängliga API-slutpunkterna, som är byggda kring REST-arkitekturen. Alla API-slutpunkter kommer att returnera ett JSON-svar med de standard HTTP-svarskoderna och kräver en Bearer-autentisering via en API-nyckel.

 

Autentisering

Alla API-slutpunkter kräver en API-nyckel som skickas med Bearer Authentication-metoden.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://web-tools.se/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Fel

Vårt API använder konventionella HTTP-statuskoder för att indikera framgång eller misslyckande för en förfrågan.

{
    "errors": [
        {
            "title": "Du har inte tillg\u00e5ng till API:et.",
            "status": 401
        }
    ]
}
200 Begäran slutförd framgångsrikt
400 Felaktig begäran – Obligatoriska parametrar saknas eller är ogiltiga
401 Obehörig - API-nyckel saknas eller är ogiltig
404 Den begärda resursen hittades inte
429 För många förfrågningar - Gräns för hastighet överskriden
500 Internt serverfel - detta betyder att det finns ett problem på vår sida
Alla API-slutpunktsresultat fungerar med UTC tidszon om inget annat anges.
Användare
Signaturer
Mina lag
Teammedlemmar
Teammedlem
Kontologgar