Dokumentacja API

Szybki start

1. 1

   Wypróbuj sprawdzenie bez klucza — zapytania anonimowe mają niższe limity na adres klienta:

   curl -s "https://correct.email/api/v1/spf?domain=example.com"

2. 2

   Utwórz klucz API na koncie i trzymaj go w zmiennej środowiskowej, nigdy w kodzie: Utwórz klucz API

   export CORRECT_EMAIL_API_KEY=ce_live_…

3. 3

   Wysyłaj go jako token typu Bearer. Sprawdzenia z kluczem wliczają się do dziennego limitu konta:

   curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
     "https://correct.email/api/v1/dmarc?domain=example.com"

Klucze API

Klucze mają postać ce_live_…; przechowujemy tylko ich skrót, więc klucz widać tylko raz — przy tworzeniu. Wysyłaj go w nagłówku Authorization: Bearer ce_live_….

Nigdy nie umieszczaj klucza na stronie internetowej ani w aplikacji mobilnej. Zapytania, które przeglądarka wysyła w imieniu innej witryny (Sec-Fetch-Site: cross-site), są odrzucane — z kluczem i bez niego.

Aby wymienić klucz bez przerwy w działaniu, użyj na koncie opcji „Wymień klucz”: nowy sekret działa od razu, a stary jeszcze przez 24 godziny (przez API od 0 do 168 godzin). Jeśli klucz wyciekł, unieważnij go — skutek jest natychmiastowy.

Na koncie widać liczbę sprawdzeń przez API z ostatnich 30 dni w podziale na dni, klucze i rodzaje sprawdzeń.

Odpowiedzi

Każde sprawdzenie odpowiada kodem 200 w tej samej kopercie, także gdy wykryje problemy — błędy HTTP oznaczają tylko zapytania, których nie dało się wykonać.

result.status

result.findings to lista uwag. Każda ma stały kod (np. spf.too_many_lookups), poziom (error, warning, info, ok), krótki opis po angielsku i — dla niektórych kodów — parametry. Porównuj kody; treść opisu może się zmienić.

Limity

Domyślne limity (operator może je zmienić; aktualne wartości zawsze podaje nagłówek RateLimit-Policy):

Nagłówki limitów

Ponawianie po 429 lub 503

# --retry honours Retry-After on 429 and 503
curl -s --retry 3 -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/mx?domain=example.com"

Błędy

Błędy mają kod HTTP i treść JSON {"error": {"code": "…", "message": "…"}}. Kod jest stały; opis to krótkie wyjaśnienie po angielsku.

Endpointy

Adres bazowy: https://correct.email/api/v1. Wszystkie sprawdzenia to zapytania GET z parametrami, poza analizą raportu DMARC, która przyjmuje plik jako treść zapytania.

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/bimi?domain=example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/dkim?domain=example.com&selector=selector1"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/dmarc?domain=example.com"

curl -s -X POST \
  -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  -H "Content-Type: application/xml" \
  --data-binary @report.xml \
  "https://correct.email/api/v1/dmarc-report"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/dnsbl?target=mx.example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/mtasts?domain=example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/mx?domain=example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/propagation?domain=example.com&type=TXT"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/rdns?target=mx.example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/smtp?domain=example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/spf?domain=example.com"

curl -s -H "Authorization: Bearer $CORRECT_EMAIL_API_KEY" \
  "https://correct.email/api/v1/tlsrpt?domain=example.com"