INTEGRITY Dokumentace

Odeslání prvního požadavku na API

Chcete-li odeslat svůj první požadavek na Cloudflare Radar API, musíte získat svůj API token nejprve. Vytvořte Custom Token s Účet > Radar v Oprávnění skupině a vyberte Čtení jako úroveň přístupu.

Jakmile máte token, jste připraveni odeslat svůj první požadavek na API Radaru na adrese https://api.cloudflare.com/client/v4/radar/.

Příklad pomocí cURL

V následujícím příkladu získáme globální procentuální rozložení typů zařízení (například mobilního a desktopového provozu) za posledních sedm dní. Další informace najdete v Získat přehled typů zařízení koncový bod:

curl "https://api.cloudflare.com/client/v4/radar/http/summary/device_type?dateRange=7d&format=json" \
--header "Authorization: Bearer <API_TOKEN>"

Úspěšná odpověď bude vypadat přibližně takto:

{
	"success": true,
	"errors": [],
	"result": {
		"summary_0": {
			"desktop": "58.223483",
			"mobile": "41.725833",
			"other": "0.050684"
		},
		"meta": {
			"dateRange": {
				"startTime": "2022-10-26T14:00:00Z",
				"endTime": "2022-11-02T14:00:00Z"
			},
			"normalization": "PERCENTAGE",
			...
		}
	}
}

Tato odpověď znamená, že 41 % požadavků je klasifikováno jako pocházející z mobilních zařízení, zatímco 58 % tvoří provoz z počítačů.

Předchozí příklad vrací veškerý provoz od botů i lidí. Můžete však zobrazit pouze provoz klasifikovaný jako pocházející od lidí (výchozí nastavení v Cloudflare Radar ↗) přidáním botClass=LIKELY_HUMAN. Můžete také získat přístup pouze k provozu pocházejícímu od botů pomocí botClass=LIKELY_AUTOMATED (viz třídy robotů pro další informace). Například:

curl "https://api.cloudflare.com/client/v4/radar/http/summary/device_type?dateRange=7d&botClass=LIKELY_AUTOMATED&format=json" \
--header "Authorization: Bearer <API_TOKEN>"

Po spuštění výše uvedeného kódu najdete nějaké rozdíly v rozložení mobilního a desktopového provozu mezi nimi?

Použijte Python

Python ↗ se stal jedním ze standardních jazyků pro analýzu dat. Zde je krátký příklad, jak stejná data vykreslit do grafu pomocí Požadavky ↗ a Pandas ↗ knihoven. Zde používáme format=csv v parametrech, aby bylo pro Pandas snazší data importovat.

import io
import requests
import pandas as pd

cf_api_url = "https://api.cloudflare.com/client/v4"
params = "dateRange=7d&format=csv"
my_token = "xxx" # TODO replace
r = requests.get(f"{cf_api_url}/radar/http/summary/device_type?{params}",
                 headers={"Authorization": f"Bearer {my_token}"})
df = pd.read_csv(io.StringIO(r.text))
df.plot(kind="bar", stacked=True)

Notebooks

A notebook ↗ je webová interaktivní výpočetní aplikace, ve které lze text, kód a výstupy kódu, jako jsou grafy, spojit do jediného dokumentu. Podívejte se na doprovodný colaboratory notebook ↗ pro další příklady použití API ve vlastních projektech.

Další kroky

Viz Porovnávání a zjistit, jak porovnávat data.