Uwierzytelnianie
Każde żądanie do API zawiera klucz API. Żądania nigdy nie są dopasowywane do sesji przeglądarki.
Tworzenie klucza API
Klucze twórz w sekcji Klucze API na swoim koncie, maksymalnie 5. Po zalogowaniu możesz w każdej chwili skopiować klucz z tej strony: przechowujemy go zaszyfrowany i pokazujemy tylko Tobie. Zachowaj go w tajemnicy, jak hasło, a jeśli mógł zostać podejrzany, unieważnij go i utwórz nowy.
Wysyłanie klucza API
Wyślij go w nagłówku Authorization jako Bearer, a po nim klucz. X-API-Key też działa.
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"Co może klucz API
Nowy klucz API może wszystko: widzi Twoje saldo, weryfikatory, Twoje zamówienia i ich wyniki oraz może używać POST /uploads, POST /estimates i POST /orders, które zapisują Twoją listę lub wydają Twoje saldo. Klucz utworzony przed 8 listopada 2026 r. może być tylko do odczytu: widzi wszystko, ale te trzy wywołania odrzucają go z kodem missing_scope.
Ważność i adresy IP
Nowy klucz API nigdy nie wygasa i działa z każdego adresu. Klucz utworzony przed 8 listopada 2026 r. może mieć datę ważności, po której jest odrzucany z kodem expired_key, albo być ograniczony do adresów IP Twojego serwera, tak że żądanie z każdego innego miejsca jest odrzucane z kodem ip_not_allowed. Aby zmienić którekolwiek z nich, utwórz nowy klucz i unieważnij stary.
Bezpieczeństwo klucza API
- Traktuj klucz API jak hasło: każdy, kto go ma, może wydać Twoje saldo.
- Używaj go tylko na swoim serwerze. API nie zezwala na wywołania ze strony internetowej.
- Nie umieszczaj go w kodzie ani w systemie kontroli wersji.
- Jeśli klucz mógł zostać podejrzany, natychmiast unieważnij go na swoim koncie. Od razu przestaje działać. Już złożone zamówienia działają dalej.
- Wysyłaj go tylko do API. Linki do przesyłania i pobierania mają własne uprawnienia, więc nie wysyłaj do nich swojego klucza API.
Gdy klucz API zostaje odrzucony
Klucz nieprawidłowy, unieważniony lub po terminie ważności daje odpowiedź 401. Zablokowany klucz lub konto daje odpowiedź 403. Zobacz Błędy.