İçeriğe geç
Doğrulandı

Genel bakış

Tek uç nokta, tek yanıt zarfı ve bir API anahtarının ulaşabildiği 337 yöntem.

Xuda panelindeki her ekran, her Studio programı ve her üçüncü taraf entegrasyonu aynı HTTP yüzeyini çağırır: platformun yöntem dağıtıcısı olan CPI. Tek bir uç nokta biçimi, /cpi/<method>, ve tek bir yanıt zarfı vardır. Bunu bir kez öğrenmek, bir hesap API anahtarının bugün ulaşabildiği 337 yöntemin tamamını kapsar.

Uç nokta

POST https://xuda.ai/cpi/<method>GET  https://xuda.ai/cpi/<method>

<method>, get_account_projects veya dbs_read gibi bir yöntem adıdır; içinde kimlik bulunan bir kaynak yolu hiçbir zaman değildir. Kimlik dahil her girdi bir parametredir: POST ile bir JSON gövdesindeki alan, GET ile bir sorgu dizesi parametresi olur (gövde ve sorgu kuralları ile cURL, JavaScript ve Python örnekleri için Bir yöntemi çağırma sayfasına bakın).

Bu belge sitesi

Belgeler xuda.ai/docs adresinde sunulur; bu yüzden bu sitedeki sanal alan /cpi/<method> adresini aynı kaynaktan çağırır. Her yerde çalışan kendi kodunuz ise https://xuda.ai/cpi/<method> adresini doğrudan çağırır.

Zarf

Her yöntem, başarılı da olsa başarısız da olsa aynı biçimde yanıt verir:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 başarıdır. Sayının kendisi pozitif olmasının ötesinde bir anlam taşımaz; data alanını okuyun.
  • code < 0 bir hatadır. data genellikle bir ileti dizesidir; bir doğrulama hatası ayrıca ondan türetilen bir message alanı ekler. Üzerinde dallanmaya değer kodlar ve yalnızca günlüğe yazıp gösterilmesi gerekenler için Hatalar sayfasına bakın.
  • Bir dosya veya özel içerik türü döndüren yöntem (bir CSV dışa aktarımı, bir görsel) JSON zarfını atlar ve kendi başlıklarını ve gövdesini ayarlar. Bu kural değil, istisnadır.
  • Başarılı bir yanıt, çağrıyı işleyen Xuda bölgesini adlandıran bir xu-region başlığı taşır. Hatalı bir yanıt taşımaz.

Yetki düzeyi ve özel duvar

Her yöntemin bir clearance değeri vardır: public, user, user_access, developer veya admin. Bu, oturum açılmış bir panel oturumu üzerinden ona kimin ulaşabileceğidir: public bir yöntem hiçbir şey gerektirmez, geri kalanı o düzeyde veya üstünde bir oturum gerektirir.

Bir API anahtarı ayrı bir duvardır, başka bir yetki düzeyi değildir. Bir yöntem ayrıca bir private bayrağı taşır. private: true mutlaktır: tam erişimli bir anahtar bile olsa, yetki düzeyi ne olursa olsun hiçbir API anahtarı onu çağıramaz. Kataloğun kabaca dörtte biri bu anlamda herkese açıktır: Voice ve Domains'ten Drive ve Studio yazma API'sine kadar her şeyi kapsayan 24 mikro hizmette 337 yöntem. Geri kalanı, api_module'ün kendi yöntemleri (API anahtarlarını oluşturan ve yöneten yöntemler) dahil, yalnızca oturumla kullanılabilir. Kimlik doğrulama sayfası tam ve özel anahtar erişimini anlatır; aşağıdaki her modül kılavuzu da kendi mikro hizmetinin sunduklarının canlı tablosuyla biter.

Bir yöntem bulma

Etkileşimli API başvurusu 337 yöntemin tümünü alanlarıyla listeler ve doğrudan tarayıcıdan kendi hesabınıza karşı birini çalıştırmanıza izin verir.