← Cloudflare Tenant / tenant

Začínáme

Díky přístupu k funkcím Cloudflare pro zřizování můžete snadněji vytvářet účty Cloudflare a spravovat je. Následující kroky vás provedou prvními voláními API pro zřizování účtů, uživatelů a služeb.

Než začnete rozhraní Tenant API používat, musíte vytvořit účet, ověřit svou e-mailovou adresu, a doplnit fakturační údaje.

Jakmile podepíšete partnerskou smlouvu se společností Cloudflare, Cloudflare přidá určité nároky k vašemu účtu, které vám umožní vytvářet a spravovat vlastní účty. Pokud jste podepsali partnerskou smlouvu a váš účet zatím nebyl aktivován, partneři MSP by měli kontaktovat [email protected] a partneři programu Agency Partners by měli kontaktovat [email protected].

Rovněž musíte získat svůj klíč API k ověření vašich požadavků vůči rozhraní Tenant API.

Další podrobnosti o používání Cloudflare API najdete v našem Přehled API.

Každý zákazník nebo tým, který používá Cloudflare, by měl mít vlastní účet. Zajistíte tím správné zabezpečení a přístup ke zdrojům. Každý účet funguje jako kontejner zón a dalších zdrojů. Podle svých potřeb můžete pro jednoho zákazníka nebo tým dokonce zřídit více účtů.

Když vytvoříte účet pomocí Tenant API, váš uživatel Cloudflare tento účet vlastní od jeho vytvoření přes průběžnou správu až po konečné odstranění.

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard"
}'

{
  "result": {
    "id": "2bab6ace8c72ed3f09b9eca6db1396bb",
    "name": "<ACCOUNT_NAME>",
    "type": "standard",
    "settings": {
      "enforce_twofactor": false
    }
  },
  "success": true,
  "errors": [],
  "messages": []
}

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard",
  "unit": {
    "id": "1a2b3c4d5e6f7g8h"
  }
}'

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard",
  "business_name": "Cloudflare",
  "business_email": "[email protected]",
  "business_address": "San Francisco",
  "business_phone": "1234567890",
  "external_metadata": "{'\''testKey'\'': '\''testValue'\''}",
  "unit": {
    "id": "1a2b3c4d5e6f7g8h"
  }
}'

Jakmile jste vytvořili účet, musíte zákazníkovi buď poskytnout přímý přístup ke Cloudflare, nebo pro něj vytvořit rozhraní, se kterým bude komunikovat.

První metoda dává zákazníkům kontrolu nad všemi aspekty Cloudflare, zatímco druhá vám umožňuje začlenit zákazníkovo prostředí Cloudflare do dashboardu, který sami spravujete a který mohou již znát.

Když udělíte uživateli přístup k účtu, Cloudflare mu zašle pozvánku, aby k účtu získal přístup. Pokud daný uživatel ještě nemá účet Cloudflare, Cloudflare ho provede procesem jeho vytvoření. Po vytvoření mu bude udělen přístup k účtu a ke všem již vytvořeným zónám.

Pokud chcete zákazníkům umožnit přístup k jejich jednotlivým účtům, jde o stejný postup, jako kdybyste pozvání člena týmu pro usnadnění správy vašeho účtu.

Přístup k dashboardu Cloudflare můžete udělit také pomocí API.

curl 'https://api.cloudflare.com/client/v4/accounts/<CUSTOMER_ACCOUNT_ID>/members' \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "email": "<CUSTOMER_EMAIL>",
  "roles": ["<USER_ROLE>"]
}'

Ve většině případů budete chtít vytvořit nové uživatele s rolí Administrator která má vždy ID 05784afa30c1afe1440e79d9351c7430.

Pokud má váš zákazník plán Enterprise, má přístup k širší sadě uživatelských rolí. Úplný seznam dostupných rolí získáte odesláním GET požadavek na rozhraní API.

Pokud chcete mít větší kontrolu nad tím, jak zákazníci Cloudflare používají, nebo chcete, aby používali váš vlastní dashboard, který už znají, vytvořte toto prostředí pomocí Cloudflare API.

To znamená, že budete volat rozhraní API Cloudflare jménem svých zákazníků. Abyste se vyhnuli omezeno rychlostí prostřednictvím našeho API doporučuje Cloudflare vytvořit účty a uživatele pro každého vašeho zákazníka. Změny provedené zákazníkem A by měly probíhat prostřednictvím uživatele A a změny provedené zákazníkem B by měly probíhat prostřednictvím uživatele B.

Chcete-li udělit přístup prostřednictvím rozhraní, musíte vytvořit servisního uživatele, protože se pod ním nikdo nebude přihlašovat do dashboardu. Pokud plánujete použít tuto metodu, Cloudflare vám umožní zobrazit klíč API, abyste mohli jménem tohoto uživatele volat rozhraní API.

curl "https://api.cloudflare.com/client/v4/users" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "email": "<[email protected]>"
}'

{
	"result": {
		"id": "60758bd48392a06215ae817bc35084b6",
		"email": "<[email protected]>",
		"first_name": null,
		"last_name": null,
		"username": "17bd2796b374cec14976ac3bced85c05",
		"telephone": null,
		"country": null,
		"created_on": "2019-02-21T23:20:28.645256Z",
		"modified_on": "2019-02-21T23:20:28.645256Z",
		"two_factor_authentication": {
			"enabled": false,
			"locked": false
		},
		"api_key": "xxx"
	},
	"success": true,
	"errors": [],
	"messages": []
}

Jakmile máte zákaznický účet a zákaznické uživatele (nebo servisní uživatele), musíte vytvořit zónu.

Chcete-li to provést, odešlete POST požadavek na /zones koncového bodu (včetně ID účtu zákazníka, které jste obdrželi v Krok 1).

curl "https://api.cloudflare.com/client/v4/zones" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "example.com",
  "account": {
    "id": "<CUSTOMER_ACCOUNT_ID>"
  }
}'

Jakmile máte pro zákazníka zřízenou zónu, můžete přidat odpovídající plán zóny podle vaší prodejní smlouvy.

Chcete-li vytvořit předplatné zóny, což se obvykle používá k upgradu plánu zóny z PARTNERS_FREE na placený Plán zóny, odešlete POST požadavek na /zones/{zone_id}/subscription koncového bodu a uveďte následující hodnoty:

• rate_plan objekt

  • Obsahuje plán zóny odpovídající tomu, co by si zákazníci objednali v dashboardu. Seznam dostupných hodnot najdete v Předplatná zón.

• component_values pole

  • Další služby podle vaší dohody o prodeji, například další page_rules.

• frequency string

  • Jak často se předplatné automaticky obnovuje (výchozí hodnota je "monthly").

curl 'https://api.cloudflare.com/client/v4/zones/{zone_id}/subscription' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "<RATE_PLAN>"
  },
  "frequency": "annual"
}'

curl 'https://api.cloudflare.com/client/v4/zones/{zone_id}/subscription' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "PARTNERS_BIZ"
  },
  "component_values": [
    {
      "name": "page_rules",
      "value": 50
    }
  ]
}

V závislosti na vaší smlouvě můžete mít povoleno prodávat další doplňkové služby. Ty se poskytují jako předplatná na úrovni účtu.

Chcete-li vytvořit předplatné účtu, odešlete POST požadavek na /accounts/{account_id}/subscriptions koncového bodu a uveďte následující hodnoty:

• rate_plan objekt

  • Obsahuje předplatné účtu odpovídající konkrétní doplňkové službě. Seznam dostupných hodnot najdete v Dostupná předplatná.

• component_values pole

  • Další služby podle vaší dohody o prodeji, například další koncové body pro vyvažování zátěže nebo další licence pro Cloudflare Zero Trust. Pokud nejsou zahrnuty, obsahuje předplatné výchozí hodnoty přiřazené ke každému nákupu.

• frequency string

  • Jak často se předplatné automaticky obnovuje (výchozí hodnota je "monthly").

curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/subscriptions' \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "rate_plan": {
    "id": "<RATE_PLAN_NAME>"
  }
}'

Jakmile přidáte potřebná předplatná, můžete vy nebo váš zákazník přejít ke konfiguraci různých služeb a doladění nastavení účtu a zóny.

Konfiguraci může provést kdokoli s přístupem k účtu (a se správnými uživatelskými oprávněními). Tento postup se neliší od konfigurace jiného účtu Cloudflare. Další pokyny najdete v našem Dokumentace k produktu.