Přehled autentizace
Caution
Ukázková stránka - Toto je ukázková stránka, která předvádí funkci dokumentace s více záložkami. Tento obsah slouží pouze pro ilustraci.
Tato příručka vysvětluje, jak se autentizovat u našeho API. Podporujeme několik metod autentizace:
API klíče
Nejjednodušší metodou autentizace je použití API klíčů. Každý API klíč je přiřazen konkrétnímu uživateli a má konkrétní oprávnění.
// Example API Key requestconst response = await fetch('https://api.example.com/data', { headers: { 'Authorization': 'Bearer YOUR_API_KEY' }});OAuth 2.0
Pro aplikace s vyššími nároky na zabezpečení podporujeme autentizační tok OAuth 2.0:
- Žádost o autorizaci: Přesměrujte uživatele na naši autorizační URL
- Souhlas uživatele: Uživatel schválí přístup ke svému účtu
- Autorizační kód: Náš server vrátí autorizační kód
- Výměna tokenu: Vyměňte kód za přístupový token
- API požadavky: Použijte přístupový token pro přístup k chráněným zdrojům
JWT tokeny
Po autentizaci vydáváme JWT tokeny, které obsahují zakódované informace o uživateli a jeho oprávněních.
// Example JWT token usageconst response = await fetch('https://api.example.com/protected-resource', { headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' }});Správa relací
Relace jsou ve výchozím nastavení platné 24 hodin. Obnovení relace provedete takto:
const refreshResponse = await fetch('https://api.example.com/auth/refresh', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer CURRENT_REFRESH_TOKEN' }});
// Parse the new tokensconst { accessToken, refreshToken } = await refreshResponse.json();Doporučené postupy
- Nikdy neukládejte API klíče ani tokeny do kódu na straně klienta
- Pro citlivé přihlašovací údaje používejte proměnné prostředí
- U dlouho běžících aplikací implementujte mechanismy obnovy tokenů
- Nastavte vhodnou dobu platnosti tokenů
- Pro všechny API požadavky používejte HTTPS