Zum Inhalt springen
Geprüft

Eine Methode aufrufen

POST oder GET, Body oder Query-String, und was der Feldvalidator erwartet.

Ein Methodenname ist Teil der URL. Jede andere Eingabe, auch eine ID, ist ein Parameter: ein JSON-Body-Feld bei POST, ein Query-String-Parameter bei GET. Beide Formen erreichen dieselbe Methode und liefern dieselbe Hülle.

POST: ein JSON-Body

Die normale Form für alles mit mehr als ein paar Parametern oder mit einem verschachtelten Objekt oder Array.

curl -s https://xuda.ai/cpi/agent_domain_connect \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_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_API_KEY',
    domain: 'example.com',
    subdomain: 'app',
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data);
import requests

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

GET: ein Query-String

Praktisch für einen schnellen Test aus der Adressleiste des Browsers oder per curl-Einzeiler. Der Server parst den Query-String in denselben Body, den der Methoden-Handler sieht, deshalb sind die folgenden Regeln hier wichtiger als bei POST.

cURL
curl -s 'https://xuda.ai/cpi/agent_domain_connect?api_key=YOUR_API_KEY&domain=example.com&subdomain=app'

Der deklarierte Typ eines Felds bestimmt, wie sein Query-String-Wert gelesen wird:

  • string: wird unverändert verwendet.
  • number: wird durch Number(...) geschickt.
  • boolean: Nur der literale String true wird als true gelesen. Alles andere, das du bei GET für ein boolean-Feld übergibst, auch false, wird zu einer wahren 1 umgewandelt. Wenn ein boolean wichtig ist, sende ihn per POST mit einem echten JSON-true/false, oder lass den Query-Parameter einfach weg, damit die Voreinstellung der Methode gilt.
  • object / array: Der Wert wird durch JSON.parse(...) geschickt, ein verschachtelter Wert muss bei GET also ein Query-Parameter sein, der einen JSON-String enthält (filters=%7B%22status%22%3A%22open%22%7D), keine Query-Verschachtelung im Klammerstil.

Pflichtfelder und Typfehler

Jedes Feld einer Methode trägt ein Flag mandatory und einen type. Fehlt ein Pflichtfeld oder sendest du bei POST (wo nichts automatisch umgewandelt wird) den falschen Typ, bekommst du ein -1 zurück, bevor die Methode selbst überhaupt läuft:

json
{ "code": -1, "data": "Error: 'domain' is a mandatory field" }
json
{ "code": -1, "data": "Error: 'domain' is a wrong type" }

Die interaktive API-Referenz listet die Felder jeder Methode mit Typen und Pflicht-Flags auf und lässt dich einen Aufruf im Browser ausführen, um die exakte Anfrage zu sehen, die er gebaut hat.

Als Nächstes