İçeriğe geç
Doğrulandı

Bir yöntemi çağırma

POST veya GET, gövde ve sorgu dizesi ve alan doğrulayıcının beklediği şey.

Yöntem adı URL'nin bir parçasıdır. Kimlik dahil her diğer girdi bir parametredir: POST ile JSON gövdesinde bir alan, GET ile bir sorgu dizesi parametresi. İki biçim de aynı yönteme ulaşır ve aynı zarfı döndürür.

POST: bir JSON gövdesi

Birkaç parametreden fazlası olan veya iç içe bir nesne ya da dizi içeren her şey için normal biçimdir.

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: bir sorgu dizesi

Bir tarayıcı adres çubuğundan veya tek satırlık bir curl ile hızlı bir denetim için kullanışlıdır. Sunucu sorgu dizesini, yöntem işleyicisinin gördüğü aynı gövdeye çözümler; bu yüzden aşağıdaki kurallar burada POST'tan daha önemlidir.

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

Bir alanın tanımlı türü, sorgu dizesi değerinin nasıl okunacağını belirler:

  • string: olduğu gibi kullanılır.
  • number: Number(...) işleminden geçirilir.
  • boolean: yalnızca true sabit dizesi true olarak okunur. GET ile bir boolean alan için ilettiğiniz diğer her şey, false dahil, doğru değerli bir 1'e çevrilir. Bir boolean önemliyse onu POST ile gerçek bir JSON true/false olarak gönderin ya da yöntemin varsayılanında kalması için sorgu parametresini hiç eklemeyin.
  • object / array: değer JSON.parse(...) işleminden geçirilir; bu yüzden GET ile iç içe bir değer, köşeli parantezli sorgu iç içeliği değil, bir JSON dizesi tutan tek bir sorgu parametresi olmalıdır (filters=%7B%22status%22%3A%22open%22%7D).

Zorunlu alanlar ve tür hataları

Bir yöntemin her alanı bir mandatory bayrağı ve bir type taşır. Zorunlu bir alanın eksik olması ya da POST ile (hiçbir şeyin otomatik dönüştürülmediği yerde) yanlış türün gönderilmesi, yöntemin kendisi çalışmadan önce size bir -1 döndürür:

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

Etkileşimli API başvurusu her yöntemin alanlarını türleri ve zorunluluk bayraklarıyla listeler ve oluşturduğu tam isteği görmek için tarayıcıdan bir çağrı çalıştırmanıza izin verir.

Sonraki