Loading...
Loading...
API wykorzystuje konwencjonalne kody odpowiedzi HTTP do wskazania sukcesu lub niepowodzenia żądań. Ta strona dokumentuje formaty błędów i strategie ich obsługi.
| Code | Description |
|---|---|
| 200 | Żądanie zakończone sukcesem. Treść odpowiedzi zawiera żądane dane. |
| 201 | Zasób pomyślnie utworzony. |
| Code | Description |
|---|---|
| 400 | Nieprawidłowe żądanie – nieprawidłowe parametry lub nieprawidłowa treść żądania |
| 401 | Nieautoryzowany – brakujący lub nieprawidłowy klucz API |
| 403 | Zabronione – klucz API nie ma wymaganych uprawnień |
| 404 | Nie znaleziono - Żądany zasób nie istnieje |
| 429 | Zbyt wiele żądań - Przekroczono limit żądań |
| 500 | Błąd wewnętrzny serwera - Skontaktuj się z pomocą techniczną, jeśli problem będzie się utrzymywał |
Wszystkie odpowiedzi błędu mają spójną strukturę JSON z obiektem błędu zawierającym pola code, message i details.
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": "The X-API-Key header is required for authentication"
}
}Ten błąd występuje, gdy klucz API jest nieobecny, nieprawidłowy lub został unieważniony. Sprawdź, czy dołączasz nagłówek X-API-Key z prawidłowym kluczem.
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": "The provided API key is invalid or has been revoked"
}
}Ten błąd występuje, gdy Twój klucz API nie ma wymaganych uprawnień dla żądanego punktu końcowego. Skontaktuj się z administratorem, aby zaktualizować uprawnienia klucza.
{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions",
"details": "This API key does not have the DEVICES_READ permission"
}
}Ten błąd występuje, gdy przekroczyłeś limit żądań. Odpowiedź zawiera informacje o tym, kiedy można ponowić próbę.
{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": "Rate limit exceeded. Try again in 45 seconds"
}
}Wdrożenie solidnej obsługi błędów w Twojej integracji, aby sprawnie radzić sobie z awariami i automatycznie ponawiać próby w przypadku błędów przejściowych.
import requests
import time
API_KEY = "nm_acme_abc123..."
BASE_URL = "https://api.nomid.tech/emm/api/v1"
def make_request(endpoint, max_retries=3):
for attempt in range(max_retries):
response = requests.get(
f"{BASE_URL}{endpoint}",
headers={"X-API-Key": API_KEY}
)
if response.status_code == 200:
return response.json()
if response.status_code == 401:
raise Exception("Invalid API key")
if response.status_code == 403:
raise Exception("Insufficient permissions")
if response.status_code == 429:
# Get retry time from header or use default
retry_after = int(response.headers.get("X-RateLimit-Reset", 60))
wait_time = min(retry_after, 60)
print(f"Rate limited. Waiting {wait_time}s...")
time.sleep(wait_time)
continue
if response.status_code >= 500:
# Exponential backoff for server errors
wait_time = (2 ** attempt) * 1
print(f"Server error. Retrying in {wait_time}s...")
time.sleep(wait_time)
continue
# Unknown error
response.raise_for_status()
raise Exception(f"Failed after {max_retries} retries")W przypadku błędów przejściowych wdróż strategię ponawiania prób z wykładniczym opóźnieniem: