← Cloudflare Fundamentals / fundamentals / api / how-to
Adresy URL šablon API tokenů
Pomocí URL šablon generujte tokeny Cloudflare API s předem nakonfigurovanými oprávněními. Díky URL šablonám můžete uživatelům sdílet požadavky na token, aniž by museli oprávnění ručně vybírat v dashboardu.
Template URL adresy využívají parametry dotazu k předvyplnění stránky pro vytvoření API tokenu v Cloudflare dashboardu. Když uživatel otevře Template URL, dashboard automaticky nastaví zadaná oprávnění a nastavení.
Cloudflare podporuje šablony URL pro uživatelské tokeny API a API tokeny účtu. Další informace o rozdílu mezi těmito typy tokenů najdete v API tokeny účtu.
Formát URL uživatelského tokenu
URL šablony uživatelských tokenů otevřou formulář pro vytvoření tokenu na úrovni uživatelského profilu (/profile/api-tokens). Tokeny vytvořené tímto způsobem vlastní uživatel.
Základní struktura adresy URL šablony je:
https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=[ENCODED_PERMISSIONS]&accountId=*&zoneId=all&name=[TOKEN_NAME]Části adresy URL
| Parametr | Povinné | Popis |
|---|---|---|
permissionGroupKeys |
Ano | URL-kódované pole JSON s objekty oprávnění |
accountId |
Ano | Rozsah účtu (použijte * pro všechny účty) |
zoneId |
Ano | Rozsah zóny (použijte all pro všechny zóny) |
name |
Ne | Předvyplněný název tokenu |
Formát URL adresy tokenu účtu
Šablonové URL adresy tokenu účtu otevírají formulář pro vytvoření tokenu na úrovni účtu. Tokeny vytvořené tímto způsobem vlastní účet (tokeny service principal) a nejsou vázány na žádného konkrétního uživatele. Vytváření tokenů účtu vyžaduje oprávnění Super Administrator nebo Administrator.
Základní struktura adresy URL šablony je:
https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=[ENCODED_PERMISSIONS]&name=[TOKEN_NAME] :account segment je zástupný symbol. Když uživatel otevře adresu URL, dashboard ho vyzve k výběru účtu, pokud má přístup k více než jednomu.
Části adresy URL
| Parametr | Povinné | Popis |
|---|---|---|
permissionGroupKeys |
Ano | URL-kódované pole JSON s objekty oprávnění |
name |
Ne | Předvyplněný název tokenu |
Formát oprávnění
Šablony URL adres pro uživatelské i účtové tokeny používají stejné kódování oprávnění. Oprávnění jsou kódována jako pole JSON s touto strukturou:
[{ "key": "permission_name", "type": "read|edit|revoke|run|purge" }]Typy oprávnění
| Typ | Popis |
|---|---|
read |
Přístup pouze pro čtení |
edit |
Plný přístup (vytváření, čtení, aktualizace, mazání) |
revoke |
Zrušit oprávnění |
run |
Oprávnění ke spouštění |
purge |
Oprávnění k vyprázdnění mezipaměti |
Vytváření vlastních šablon
1. Určete požadovaná oprávnění
Uveďte oprávnění, která váš případ použití potřebuje. Podívejte se na reference oprávnění tabulka.
2. Vytvořte JSON s oprávněními
Naformátujte svá oprávnění jako pole JSON:
[
{ "key": "dns", "type": "edit" },
{ "key": "analytics", "type": "read" }
]3. Proveďte URL kódování JSON
Pomocí URL kodéru převeďte řetězec JSON:
%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22analytics%22%2C%22type%22%3A%22read%22%7D%5D4. Sestavte úplnou URL
Pro token uživatele, zkombinujte všechny komponenty do výsledné šablony URL:
https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=[ENCODED_JSON]&accountId=*&zoneId=all&name=Custom%20TokenPro token účtu, použijte místo toho cestu na úrovni účtu:
https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=[ENCODED_JSON]&name=Custom%20TokenReference oprávnění
V této tabulce najdete klíče oprávnění pro vlastní šablony.
Oprávnění účtu
| Klíč oprávnění | Popis | Běžné případy použití |
|---|---|---|
account_analytics |
Analytika účtu | Reportování, monitorování |
account_api_tokens |
Správa API tokenů | Automatizace tokenů |
account_settings |
Konfigurace účtu | Správa účtu |
billing |
Fakturační údaje | Sledování nákladů, fakturace |
workers_scripts |
Skripty Workers | Serverless funkce |
workers_kv_storage |
Workers KV storage | Ukládání dat |
workers_routes |
Workers routes | Směrování provozu |
workers_r2 |
úložiště R2 | Objektové úložiště |
d1 |
databáze D1 | SQL databáze |
queues |
Queues | Fronty zpráv |
page |
Cloudflare Pages | Nasazení Pages |
stream |
Stream | Streamování videa |
images |
Obrázky | Optimalizace obrázků |
logs |
Protokoly | Správa logů |
Oprávnění zóny
| Klíč oprávnění | Popis | Běžné případy použití |
|---|---|---|
dns |
DNS záznamy | Správa domén |
zone |
Správa zóny | Konfigurace domény |
zone_settings |
Nastavení zóny | Konfigurace zóny |
analytics |
Analytika zóny | Sledování výkonu |
firewall_services |
Pravidla firewallu | Správa zabezpečení |
page_rules |
Page rules | Řízení provozu |
cache |
Čištění mezipaměti | Aktualizace obsahu |
ssl_and_certificates |
Certifikáty SSL/TLS | Správa certifikátů |
Oprávnění Access
| Klíč oprávnění | Popis | Běžné případy použití |
|---|---|---|
access |
Aplikace Access | Aplikace Zero Trust |
access_acct |
Organizace Access | Správa identit |
access_audit_log |
auditní protokoly Access | Dodržování předpisů, zabezpečení |
access_custom_page |
Vlastní stránky | Branding, uživatelská zkušenost |
teams |
Zero Trust | Gateway, CASB, DLP |
Běžné šablony oprávnění
Použijte tyto předpřipravené URL šablony pro běžné scénáře. Každý příklad obsahuje URL pro uživatelský token i URL pro účtový token.
Správa DNS
Vytvářejte tokeny pro správu DNS záznamů.
Uživatelský token
| Případ použití | Template URL |
|---|---|
| DNS read-only | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22read%22%7D%5D&accountId=%2A&zoneId=all&name=DNS%20Read%20Token |
| DNS read/write | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22edit%22%7D%5D&accountId=%2A&zoneId=all&name=DNS%20Management%20Token |
Token účtu
| Případ použití | Template URL |
|---|---|
| DNS read-only | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22read%22%7D%5D&name=DNS%20Read%20Token |
| DNS read/write | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22edit%22%7D%5D&name=DNS%20Management%20Token |
Vývoj ve Workers
Vytvářejte tokeny pro Workers, úložiště KV a související služby.
Uživatelský token
| Případ použití | Template URL |
|---|---|
| Pouze skripty Workers | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22workers_scripts%22%2C%22type%22%3A%22edit%22%7D%5D&accountId=%2A&zoneId=all&name=Workers%20Scripts%20Token |
| Plný přístup k Workers | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22workers_scripts%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22workers_kv_storage%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22workers_routes%22%2C%22type%22%3A%22edit%22%7D%5D&accountId=%2A&zoneId=all&name=Workers%20Full%20Access%20Token |
Token účtu
| Případ použití | Template URL |
|---|---|
| Pouze skripty Workers | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22workers_scripts%22%2C%22type%22%3A%22edit%22%7D%5D&name=Workers%20Scripts%20Token |
| Plný přístup k Workers | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22workers_scripts%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22workers_kv_storage%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22workers_routes%22%2C%22type%22%3A%22edit%22%7D%5D&name=Workers%20Full%20Access%20Token |
Analýza a monitorování
Vytvářejte tokeny pro přístup k analytickým datům a protokolům.
Uživatelský token
| Případ použití | Template URL |
|---|---|
| Analytika účtu | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22account_analytics%22%2C%22type%22%3A%22read%22%7D%5D&accountId=%2A&zoneId=all&name=Account%20Analytics%20Token |
| Analytika zóny | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22analytics%22%2C%22type%22%3A%22read%22%7D%5D&accountId=%2A&zoneId=all&name=Zone%20Analytics%20Token |
Token účtu
| Případ použití | Template URL |
|---|---|
| Analytika účtu | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22account_analytics%22%2C%22type%22%3A%22read%22%7D%5D&name=Account%20Analytics%20Token |
| Analytika zóny | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22analytics%22%2C%22type%22%3A%22read%22%7D%5D&name=Zone%20Analytics%20Token |
Správa Zero Trust
Vytvářejte tokeny pro správu Cloudflare Zero Trust.
Uživatelský token
| Případ použití | Template URL |
|---|---|
| Čtení aplikací Access | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22access%22%2C%22type%22%3A%22read%22%7D%5D&accountId=%2A&zoneId=all&name=Access%20Read%20Token |
| Úplná správa Access | https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22access%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22access_acct%22%2C%22type%22%3A%22edit%22%7D%5D&accountId=%2A&zoneId=all&name=Access%20Management%20Token |
Token účtu
| Případ použití | Template URL |
|---|---|
| Čtení aplikací Access | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22access%22%2C%22type%22%3A%22read%22%7D%5D&name=Access%20Read%20Token |
| Úplná správa Access | https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=%5B%7B%22key%22%3A%22access%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22access_acct%22%2C%22type%22%3A%22edit%22%7D%5D&name=Access%20Management%20Token |
Osvědčené postupy
Při vytváření a sdílení šablonových adres URL se řiďte těmito pokyny.
- Princip nejnižších oprávnění: Vyžadujte pouze minimální oprávnění nezbytná pro váš případ použití. Tím se sníží bezpečnostní rizika v případě, že dojde ke zneužití tokenu.
- Používejte popisné názvy tokenů: do URL šablon zahrňte jasné a popisné názvy, aby uživatelé snadno pochopili účel tokenu.
- Zdokumentujte použití tokenu: Uveďte jasně, k čemu se každý token používá a jak ho v případě potřeby zneplatnit.
- Pravidelná rotace tokenů: Vybízejte uživatele k pravidelné rotaci tokenů a kontrole oprávnění.
- Otestujte před sdílením: Template URL adresy vždy nejprve vyzkoušejte ve zkušebním prostředí, než je poskytnete uživatelům.
Řešení potíží
Prohlédněte si seznam běžných problémů a jejich řešení.
| Vystavit | Řešení |
|---|---|
| Adresa URL nepředvyplňuje oprávnění | Ověřte, že je JSON správně URL-encoded |
| Oprávnění chybí | Zkontrolujte klíče oprávnění v referenční tabulce |
| Název tokenu se nezobrazuje | Ujistěte se, že je parametr name zakódovaný pomocí URL encoding |
| Chyba Access Denied | Ověřte, že uživatel má v účtu požadovaná oprávnění |
Před sdílením adresy URL šablony si navíc projděte kontrolní seznam.
- Všechny klíče oprávnění jsou správné
- Syntaxe JSON je platná
- Kódování adresy URL je správné
- Název tokenu je popisný
- Oprávnění dodržují princip nejnižších oprávnění