Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Κλήση μιας μεθόδου

POST ή GET, σώμα έναντι συμβολοσειράς ερωτήματος, και τι περιμένει ο επικυρωτής πεδίων.

Το όνομα μιας μεθόδου είναι μέρος της διεύθυνσης URL. Κάθε άλλη είσοδος, συμπεριλαμβανομένου ενός αναγνωριστικού, είναι παράμετρος: πεδίο σώματος JSON στο POST, παράμετρος συμβολοσειράς ερωτήματος στο GET. Και οι δύο μορφές φτάνουν στην ίδια μέθοδο και επιστρέφουν τον ίδιο φάκελο απάντησης.

POST: σώμα JSON

Η κανονική μορφή για οτιδήποτε έχει περισσότερες από λίγες παραμέτρους, ή έχει ένθετο αντικείμενο ή πίνακα.

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: συμβολοσειρά ερωτήματος

Βολική για έναν γρήγορο έλεγχο από τη γραμμή διευθύνσεων του προγράμματος περιήγησης ή μια εντολή curl μίας γραμμής. Ο διακομιστής αναλύει τη συμβολοσειρά ερωτήματος στο ίδιο σώμα που βλέπει ο χειριστής της μεθόδου, οπότε οι κανόνες παρακάτω μετράνε περισσότερο εδώ από ό,τι στο POST.

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

Ο δηλωμένος τύπος ενός πεδίου καθορίζει πώς διαβάζεται η τιμή του στη συμβολοσειρά ερωτήματος:

  • string: χρησιμοποιείται ως έχει.
  • number: περνά από το Number(...).
  • boolean: μόνο η κυριολεκτική συμβολοσειρά true διαβάζεται ως true. Οτιδήποτε άλλο περάσετε για ένα πεδίο boolean στο GET, συμπεριλαμβανομένου του false, μετατρέπεται σε αληθές 1. Αν ένα boolean έχει σημασία, στείλτε το με POST με πραγματικό JSON true/false, ή απλώς παραλείψτε την παράμετρο ερωτήματος για να μείνει στην προεπιλογή της μεθόδου.
  • object / array: η τιμή περνά από το JSON.parse(...), οπότε μια ένθετη τιμή στο GET πρέπει να είναι μία παράμετρος ερωτήματος που κρατά μια συμβολοσειρά JSON (filters=%7B%22status%22%3A%22open%22%7D), όχι ένθεση ερωτήματος τύπου αγκυλών.

Υποχρεωτικά πεδία και σφάλματα τύπου

Τα πεδία μιας μεθόδου φέρουν το καθένα μια σημαία mandatory και έναν type. Αν λείπει ένα υποχρεωτικό πεδίο, ή στείλετε λάθος τύπο στο POST (όπου τίποτα δεν μετατρέπεται αυτόματα), παίρνετε πίσω ένα -1 πριν καν εκτελεστεί η ίδια η μέθοδος:

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

Η διαδραστική αναφορά API απαριθμεί τα πεδία κάθε μεθόδου με τους τύπους και τις σημαίες υποχρεωτικότητάς τους, και σας επιτρέπει να εκτελέσετε μια κλήση από το πρόγραμμα περιήγησης για να δείτε το ακριβές αίτημα που δημιούργησε.

Επόμενα