Przegląd
Jeden punkt końcowy, jedna koperta odpowiedzi i 337 metod, do których ma dostęp klucz API.
Każdy ekran w panelu Xuda, każdy program Studio i każda integracja zewnętrzna wywołuje tę samą
powierzchnię HTTP: CPI, czyli skrót od dyspozytora metod platformy. Jest jeden kształt punktu
końcowego, /cpi/<method>, i jedna koperta odpowiedzi. Nauczenie się ich raz obejmuje wszystkie
337 metod, do których klucz API konta ma dziś dostęp.
Punkt końcowy
<method> to nazwa metody, taka jak get_account_projects albo dbs_read, nigdy ścieżka zasobu
z identyfikatorem w środku. Każde wejście, także identyfikator, jest parametrem: w POST to pole
w treści JSON, w GET parametr w ciągu zapytania (zasady treść kontra zapytanie i przykłady w cURL,
JavaScript i Python znajdziesz w Wywoływanie metody).
Dokumentacja jest dostępna pod xuda.ai/docs, więc piaskownica na tej stronie wywołuje /cpi/<method>
z tego samego pochodzenia. Twój własny kod, uruchomiony gdziekolwiek, wywołuje bezpośrednio
https://xuda.ai/cpi/<method>.
Koperta
Każda metoda, z sukcesem czy porażką, odpowiada w tym samym kształcie:
code > 0oznacza sukces. Sama liczba nie niesie żadnego znaczenia poza tym, że jest dodatnia, czytajdata.code < 0to błąd.datajest zwykle komunikatem tekstowym, a błąd walidacji dodaje też polemessagez niego wyprowadzone. Kody warte rozgałęziania oraz te, które wystarczy zalogować i pokazać, opisuje Błędy.- Metoda zwracająca plik albo własny typ zawartości (eksport CSV, obraz) pomija kopertę JSON i zamiast niej ustawia własne nagłówki i treść. To wyjątek, a nie reguła.
- Udana odpowiedź niesie nagłówek
xu-regionz nazwą regionu Xuda, który obsłużył wywołanie. Odpowiedź z błędem go nie niesie.
Poziom dostępu i prywatny mur
Każda metoda ma clearance: public, user, user_access, developer albo admin. To określa,
kto może po nią sięgnąć przez zalogowaną sesję panelu: metoda public nie wymaga niczego,
pozostałe wymagają sesji na tym poziomie lub wyższej.
Klucz API to osobny mur, a nie kolejny poziom dostępu. Metoda ma też flagę private.
private: true jest bezwzględne: żaden klucz API nie może jej wywołać, nawet z pełnym dostępem,
niezależnie od jej poziomu clearance. Mniej więcej jedna czwarta katalogu jest publiczna w tym
sensie: 337 metod w 24 mikroserwisach, od Voice i Domen po Drive i API do tworzenia w Studio.
Reszta, w tym każda metoda samego api_module (metody tworzące kluczami API i zarządzające nimi),
pozostaje tylko dla sesji. Uwierzytelnianie opisuje pełny i niestandardowy
dostęp klucza, a każdy z poniższych przewodników po modułach kończy się aktualną tabelą tego, co
udostępnia jego mikroserwis.
Znajdowanie metody
Interaktywna dokumentacja API wymienia wszystkie 337 metod z ich polami i pozwala uruchomić dowolną na własnym koncie prosto z przeglądarki.