Naar de inhoud springen
Geverifieerd

Een domein verbinden

Wijs met een sleutel met App-bereik een van de eigen domeinen van het account via DNS naar het project van deze sleutel.

agent_domain_connect is een aanroep met projectbereik: anders dan elke andere schrijfactie in deze sectie neemt hij geen app_id. Het project waar hij een domein naartoe wijst is het project waaruit de API-sleutel zelf is gemaakt, dus dit recept heeft een App-sleutel nodig (gemaakt op het eigen API-tabblad van een project), geen Account-sleutel. agent_domain_list is de bijbehorende leesaanroep: de eigen domeinen van het account, zodat je altijd een naam stuurt die het account echt bezit.

Methoden

POST/cpi/agent_domain_list
user

Domains: list

List the account's registered domains (name, status, which app each is attached to). Use this BEFORE asking the user to type a domain: if they say 'connect one of my domains', call this and present the options.

POST/cpi/agent_domain_connect
user

Domains: connect to this VPS

Point one of the account's own domains (from agent_domain_list) at THIS project's VPS via DNS. Optional subdomain (e.g. 'app' -> app.example.com); omit to use the apex. Prefer a subdomain unless the user explicitly wants the apex. Attaching replaces any existing record on that exact hostname.

Hiervoor heb je een App-sleutel nodig, geen Account-sleutel

Beide methoden bepalen uid uit de sleutel die je stuurt, net als overal, maar agent_domain_connect bepaalt er ook app_id uit, en alleen een sleutel die op het API-tabblad van een project is gemaakt heeft er een. Roep hem aan met een Account-sleutel en hij antwoordt -1, 'no app is bound to this action', nog voordat hij naar het domein kijkt. Zie Authentication voor de drie bereiken van sleutels.

Stappenplan

Vraag de domeinen van het account op

Geen velden behalve je sleutel. Elke rij is een domein dat het account via Xuda heeft geregistreerd of heeft verbonden door zijn nameservers te delegeren, naar welk project (als er een is) het nu ook wijst, met zijn eigen status.

curl -s https://xuda.ai/cpi/agent_domain_list \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_list', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) for (const d of data.domains) console.log(d.domain, d.status, d.attached_app_id);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_list',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for d in body['data']['domains']:
        print(d['domain'], d['status'], d['attached_app_id'])

2. Wijs er een naar het project van deze sleutel

domain moet een van de namen zijn die de vorige aanroep teruggaf. subdomain is optioneel en staat los van de eigen projectnaam van de app-sleutel: het is een label op het domein ("app" voor app.example.com); laat hem weg om in plaats daarvan de apex van het domein te wijzen. Dit opnieuw uitvoeren met een andere subdomain verstoort een hostnaam die je al hebt gekoppeld niet: alleen het record van precies die hostnaam wordt vervangen.

curl -s https://xuda.ai/cpi/agent_domain_connect \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_APP_API_KEY","domain":"example.com","subdomain":"app"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_connect', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_APP_API_KEY',
    domain: 'example.com',
    subdomain: 'app',
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.record.type, data.record.name, data.record.target);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_connect',
    json={'api_key': 'YOUR_APP_API_KEY', 'domain': 'example.com', 'subdomain': 'app'},
)
body = res.json()
if body['code'] > 0:
    print(body['data']['record']['type'], body['data']['record']['name'], body['data']['record']['target'])

Het antwoord

agent_domain_list knipt elk opgeslagen domeindocument terug tot vier velden:

json
{
  "code": 1,
  "data": {
    "count": 2,
    "domains": [
      {
        "domain": "example.com",
        "status": "active",
        "connection_type": "registered",
        "attached_app_id": null
      },
      {
        "domain": "example.org",
        "status": "active",
        "connection_type": "connected",
        "attached_app_id": "app_5d9e21"
      }
    ]
  }
}

connection_type is registered voor een domein dat via Xuda is gekocht (Xuda is de registrar en de DNS) of connected voor een domein dat elders is geregistreerd met nameservers die naar Xuda zijn gedelegeerd (alleen DNS, de registratie blijft waar hij was). Beide werken hetzelfde voor agent_domain_connect.

agent_domain_connect antwoordt met het DNS-record dat hij echt heeft geschreven:

json
{
  "code": 1,
  "data": {
    "ok": true,
    "record": {
      "type": "A",
      "name": "app.example.com",
      "target": "203.0.113.42",
      "proxied": true,
      "ssl_mode": "full"
    }
  }
}

type hangt af van wat voor soort project de sleutel als bereik heeft, niet van iets wat je stuurt: een VPS-project krijgt een A-record naar zijn IP (of AAAA op een farm-VM zonder openbaar IPv4), al het andere krijgt een CNAME naar de eigen toegangs-URL van het project. Elk record loopt via de Cloudflare-proxy (proxied: true), dus de bezoeker krijgt in beide gevallen HTTPS aan de rand. ssl_mode wordt alleen gezet bij het VPS-pad, waar Xuda ook de SSL-modus van de herkomst van de zone test en instelt (full, strict of flexible); bij een CNAME-doel komt hij terug als null: de eigen Universal SSL van Cloudflare dekt dat geval zonder dat er een zone-instelling te melden is.

Fouten

Volgende stap