Hopp til innholdet
Bekreftet

Autentisering

API-nøkler for kontoen, full mot egendefinert tilgang, og hvor du oppretter en.

Hvert kall til CPI har en API-nøkkel. Det finnes ingen egen klient-id, ingen OAuth-håndtrykk, ingen signatur å beregne, én nøkkel, sendt med forespørselen.

Å opprette en nøkkel

Nøkler ligger i dashbordet, under skjermen Utviklere i kontomenyen, i fanen API-nøkler. Et prosjekt har sin egen API-fane som oppretter den samme typen nøkkel allerede avgrenset til det prosjektet, så du aldri skriver inn en app_id for hånd. Sandkassen i den interaktive API-referansen kan også opprette en for deg på stedet, slik at du kan prøve en metode før du kobler noe inn i din egen kode.

Identitetsverifisering

For å opprette en API-nøkkel kreves identitetsverifisering, den samme nivå 2-sjekken Xuda ber om før et telefonnummer, en postboks eller en bærbar IP deles ut. En konto uten noe verifisert får en oppfordring om å verifisere før nøkkelskjemaet åpnes.

Omfang: hvilken konto nøkkelen handler som

En nøkkel opprettes med ett av tre omfang, og handler alltid på kontoen eller appen den ble opprettet mot:

  • Konto: handler direkte på kontoen din, slik du ville gjort fra en innlogget dashbordøkt. Når alle metoder en vanlig kontonøkkel kan nå.
  • App: opprettet fra et prosjekts egen API-fane, festet til prosjektets app_id.
  • Full stack-VPS: utstedes automatisk når du klargjør en Full stack-VPS, avgrenset til egenskapsgruppene som ble valgt ved opprettelsen. Se Full stack-VPS for hva det dekker.

Tilgang: full eller egendefinert

Hver nøkkel velger også hvor mye av den offentlige flaten den kan nå:

  • Full tilgang: alt kontoen kan gjøre over API-et, også metoder som er lagt til etter at nøkkelen ble opprettet. Private metoder er alltid utelatt uansett: private: true er en hard mur, sjekket ved hvert kall, ikke en standard full tilgang overstyrer.
  • Egendefinert tilgang: en eksplisitt tillatelsesliste du bygger ved å huke av metoder i nøkkelskjemaet, gruppert etter mikrotjeneste med hver metodes felt vist på linjen. En metode som legges til senere, er ikke inkludert før du kommer tilbake og tillater den. En metode hvis clearance er public, kan alltid nås, selv med en egendefinert nøkkel uten noe avhuket, siden en offentlig metode ikke trenger noen økt og ingen oppføring i tillatelseslisten.
api_module-metoder er kun for økter

Metodene som oppretter, oppdaterer og lister API-nøkler (create_account_api_key, get_app_api_keys og resten av api_module) kan aldri nås med en API-nøkkel, med vilje: en legitimasjon kan ikke opprette eller redigere legitimasjon for kontoen den autentiserer. Administrer nøkler fra dashbordet eller fra en innlogget økt.

Å sende nøkkelen

Over vanlig REST er nøkkelen nok en forespørselsparameter, kalt api_key: et felt i JSON-kroppen ved POST, en spørrestrengparameter ved GET. Se Å kalle en metode for begge formene.

cURL
curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'

Over MCP går den samme nøkkelen i en Authorization: Bearer-overskrift i stedet, det finnes ikke noe api_key-felt. Se MCP.

claude mcp add
claude mcp add --transport http xuda https://xuda.ai/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"
Hold den på serversiden

En API-nøkkel er en bærer-legitimasjon: den som har den, handler som kontoen din. Send den aldri med i kode på klientsiden, sjekk den aldri inn, og lim den aldri inn i et delt skjermbilde. Bytt ut en nøkkel med en gang hvis den noen gang dukker opp et av de stedene. Å bytte ut beholder navn og tilgangsmodus og trekker tilbake den gamle verdien i samme trinn.

Neste