Fejlkoder

Auditply API bruger standard HTTP-statuskoder og returnerer strukturerede fejlmeddelelser.

Fejl-format

Alle fejlresponses har dette format:

Eksempel: 404 Not Found

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "KYC case with ID 999 not found.",
    "status": 404
  },
  "meta": {
    "api_version": "v1",
    "timestamp": "2026-04-13T12:00:00.000Z"
  }
}

Oversigt

Kode	HTTP	Beskrivelse
MISSING_API_KEY	401	Ingen X-API-Key header i requestet
INVALID_API_KEY	401	API-nøglen er ugyldig, udløbet eller tilbagekaldt
INSUFFICIENT_SCOPE	403	API-nøglen mangler det nødvendige scope
RATE_LIMIT_EXCEEDED	429	For mange requests — vent og prøv igen
VALIDATION_ERROR	400	Ugyldige query-parametre eller input
RESOURCE_NOT_FOUND	404	Ressourcen blev ikke fundet
INTERNAL_ERROR	500	En uventet serverfejl

Fejlhåndtering

Vi anbefaler at du altid tjekker HTTP-statuskoden før du parser response:

JavaScript

const res = await fetch(url, {
  headers: { "X-API-Key": apiKey },
});

if (!res.ok) {
  const { error } = await res.json();

  switch (error.code) {
    case "RATE_LIMIT_EXCEEDED":
      const retryAfter = res.headers.get("Retry-After");
      console.log(`Rate limited. Retry in ${retryAfter}s`);
      break;
    case "INVALID_API_KEY":
      console.error("API-nøgle er ugyldig");
      break;
    default:
      console.error(`Fejl: ${error.message}`);
  }
}

Python

response = requests.get(url, headers={"X-API-Key": api_key})

if not response.ok:
    error = response.json()["error"]

    if error["code"] == "RATE_LIMIT_EXCEEDED":
        retry_after = int(response.headers.get("Retry-After", 5))
        print(f"Rate limited. Retry in {retry_after}s")
        time.sleep(retry_after)
    elif error["code"] == "INVALID_API_KEY":
        print("API-nøgle er ugyldig")
    else:
        print(f"Fejl: {error['message']}")