/
CLI- och API-referens
📘 Allmänna API-resurser
Välkommen till Esadax API-referens. Här hittar du all viktig information du behöver för att interagera med vårt API, inklusive hur du autentiserar, förstår svarstatusar och löser valideringsfel.
Autentisering
Alla API-förfrågningar måste autentiseras med hjälp av en API-token. Detta görs genom att lägga till ett Authorization-huvud till din HTTP-förfrågan.
✅ Huvudformat
Authorization: Bearer XXX
Ersätt XXX med din faktiska API-token.
Om API-tokens
- API-tokens genereras per användarkonto.
- Varje token kan ha anpassade behörigheter för att begränsa åtkomsten till specifika delar av ditt konto.
- Detta hjälper till att hålla din integration säker genom att endast bevilja den åtkomst som är nödvändig.
➡️ Läs mer om att hantera API-tokens
Användargränssnittssvar
Esadax använder RESTful principer och överensstämmer med standard HTTP svar praxis. Varje svar från API:et innehåller en relevant HTTP-statuskod som anger om din begäran lyckades eller misslyckades.
📊 HTTP-statuskoder
| Kod | Namn | Beskrivning |
|---|---|---|
| 200 | Okej. | Begäran accepterades framgångsrikt. |
| 201 sid. | Skapad | Resursen har skapats. |
| 202 sid. | Godkänd | Begäran accepterades och bearbetningen fortsätter i bakgrunden. |
| 204 sid. | Inget innehåll hittades | Begäran godkändes, men det finns inget innehåll att returnera. |
| 400 | Dålig begäran | Det uppstod ett fel med din begäran. Kontrollera slutpunktskraven och försök igen. |
| 401 artiklar | Obehörig | Ogiltig API token. Läs mer. |
| 403 sid. | Förbjudet | Åtgärden är inte tillåten för detta token eller konto. Kontrollera tokenbehörigheter. |
| 404 | Sidan hittades inte | Den begärda resursen hittades inte. |
| 405 sid. | Metod ej tillåten | HTTP-metoden som används stöds inte för den här slutpunkten. |
| 408 sid. | Tidsgräns för begäran | Det blev timeout i vår ände. Vänligen kontakta support. |
| 421 sid. | Tjänsten är inte tillgänglig | Webbplatsen genomgår just nu underhåll. Försök igen senare. |
| 422 sid. | Entitet som inte kan bearbetas | Valideringsfel i din förfrågan. Granska och försök igen. Läs mer |
| 429 sid. | För många förfrågningar | Hastighetsgräns överskriden. Läs mer om hastighetsgränser |
| 500 | Internt serverfel | Oväntat serverfel. Vänligen kontakta support. |
| 502 sid. | Ogiltig gateway | Tillfälligt systemfel. Vänligen kontakta support. |
| 503 sid. | Tjänsten är inte tillgänglig | Webbplatsen är för närvarande inte tillgänglig. Vänligen kontakta support. |
| 504 sid. | Tidsgräns för gateway | Det uppstod en timeout på vårt system. Vänligen kontakta support. |
🔗 Mer information om HTTP-statuskoder finns på Mozilla Developer Network.
SQL-valideringsfel
Valideringsfel (HTTP 422) inträffar när nyttolasten för din begäran inte uppfyller kraven för en viss slutpunkt. Detta kan bero på:
- Saknade obligatoriska fält
- Ogiltiga dataformat
- Felaktiga parametrar
Dubbelkolla alltid API endpoint documentation för att säkerställa att din begäran matchar det förväntade formatet.
