Dokumentacja API
Uruchamiaj testy dostarczalności programowo. RESTful JSON API z uwierzytelnianiem Bearer.
Uwierzytelnianie
Obsługiwane są dwie metody uwierzytelniania:
Token sesji
Uzyskiwany przez POST /v1/auth/verify-code. Do użycia w panelu lub aplikacjach klienckich.
Klucz API
Klucze per projekt, format: gms_live_.... Do integracji serwer-serwer.
Authorization: Bearer gms_live_a1b2c3d4e5f6...Endpointy
POST
/v1/public/tests Utwórz anonimowy test. Zwraca adres testowy i publiczny token.
Response 202
{
"public_token": "abc123xyz789",
"test_address": "[email protected]",
"expires_at": "2025-01-16T12:00:00Z"
} GET
/v1/public/tests/{token} Sprawdź status testu. Odpytuj aż status będzie "complete".
Response 200
{
"public_token": "abc123xyz789",
"status": "complete",
"created_at": "2025-01-15T12:00:00Z",
"expires_at": "2025-01-16T12:00:00Z",
"email_received_at": "2025-01-15T12:01:23Z"
} GET
/v1/public/tests/{token}/details Pełny wynik analizy. Dostępny tylko gdy status to complete.
Response 200 (truncated)
{
"overall_score_100": 85,
"display_score_10": 8.5,
"category_scores": {
"authentication": 100,
"infrastructure": 75,
"content": 90
},
"auth_results": { "spf": {...}, "dkim": {...}, "dmarc": {...} },
"infra_findings": [...],
"content_findings": [...],
"recommendations": [
{ "priority": "high", "title": "...", "action": "..." }
]
} POST
/v1/tests wymaga uwierzytelnienia Utwórz test przypisany do projektu. Ten sam format odpowiedzi co publiczny endpoint.
GET
/v1/tests wymaga uwierzytelnienia Lista testów projektu ze statusem i wynikami.
Kody statusów
202 Test utworzony, oczekiwanie na e-mail 200 Sukces 404 Nieznany token lub zasób 410 Wygasły token testu 429 Przekroczono limit zapytań