Authentication
API-nycklar för kontot, full jämfört med anpassad åtkomst och var du skapar en.
Varje anrop till CPI har en API-nyckel. Det finns inget separat klient-id, ingen OAuth-handskakning och ingen signatur att beräkna: en nyckel, som skickas med anropet.
Skapa en nyckel
Nycklar finns i dashboarden, på skärmen Utvecklare i kontomenyn, under fliken API-nycklar.
Ett projekt har en egen flik API som skapar samma sorts nyckel, redan begränsad till det
projektet, så att du aldrig skriver in ett app_id för hand. Sandlådan i den interaktiva
API reference kan också skapa en åt dig på stället, så att du kan prova en metod
innan du kopplar in något i din egen kod.
För att skapa en API-nyckel krävs identitetsverifiering, samma nivå 2-kontroll som Xuda kräver innan ett telefonnummer, en brevlåda eller en portabel IP-adress lämnas ut. Ett konto utan något verifierat ser en uppmaning att verifiera innan nyckelformuläret öppnas.
Omfång: vilket konto nyckeln agerar som
En nyckel skapas med ett av tre omfång och agerar alltid på kontot eller appen den skapades mot:
- Konto: agerar direkt på ditt konto, så som du skulle göra från en inloggad dashboardsession. Når alla metoder som en vanlig kontonyckel kan nå.
- App: skapas från ett projekts egen API-flik och är knuten till projektets
app_id. - Fullstack-VPS: utfärdas automatiskt när du tillhandahåller en Fullstack-VPS, begränsad till de funktionsgrupper som valdes vid skapandet. Se Full Stack VPS för vad det omfattar.
Åtkomst: full eller anpassad
Varje nyckel väljer också hur mycket av den offentliga ytan den kan nå:
- Full åtkomst: allt kontot kan göra via API:et, inklusive metoder som lagts till efter att
nyckeln skapades. Privata metoder är undantagna oavsett vad:
private: trueär en hård mur som kontrolleras vid varje anrop, inte ett standardvärde som full åtkomst åsidosätter. - Anpassad åtkomst: en uttrycklig tillåtelselista som du bygger genom att kryssa i metoder i
nyckelformuläret, grupperade per mikrotjänst med varje metods fält visade direkt. En metod som
läggs till senare ingår inte förrän du kommer tillbaka och tillåter den. En metod vars
clearanceärpublicgår alltid att nå, även med en anpassad nyckel utan något ikryssat, eftersom en offentlig metod varken kräver session eller någon post i tillåtelselistan.
Metoderna som skapar, uppdaterar och listar API-nycklar (create_account_api_key,
get_app_api_keys och resten av api_module) går aldrig att nå med en API-nyckel, med avsikt: en
behörighet kan inte skapa eller redigera behörigheter för kontot den autentiserar. Hantera nycklar
från dashboarden eller från en inloggad session.
Skicka nyckeln
Över vanlig REST är nyckeln ytterligare en förfrågningsparameter, med namnet api_key: ett fält i
JSON-kroppen vid POST, en parameter i frågesträngen vid GET. Se
Calling a method för båda formerna.
Över MCP går samma nyckel i en Authorization: Bearer-rubrik i stället, och det finns inget
api_key-fält. Se MCP.
En API-nyckel är en bärarbehörighet: den som har den agerar som ditt konto. Skicka aldrig med en i kod på klientsidan, checka inte in den och klistra inte in den i en delad skärmbild. Byt ut en nyckel direkt om den någonsin dyker upp på något av de ställena. Att byta ut behåller namn och åtkomstläge och återkallar det gamla värdet i samma steg.