Lämpliga scenarier: Du bygger en tredjepartsapplikation / Agent / MCP-klient / automatiserat arbetsflöde och vill låta användare logga in med sitt Ace Data Cloud-konto med ett klick och vid behov komma åt sina resurser på plattformen, utan att användaren manuellt behöver kopiera och klistra in API Key.
Snabböversikt över termer & ändpunkter
Alla ändpunkter finns påhttps://auth.acedata.cloud, och de senaste adresserna kan alltid hämtas via upptäcktsändpunkten (Discovery):
Följande funktioner stöds:
response_type=code, grant_types=authorization_code, refresh_token, code_challenge_methods=S256, plain, klientautentiseringsmetoderna client_secret_post (konfidentiella klienter) / none (offentliga PKCE-klienter).
Behörighetsomfång (Scope)
Begär enligt ”minsta behörighet”, användaren kommer att se varje behörighet du begär på auktoriseringssidan. Identitetsrelaterade (OIDC-kompatibla)
Plattformsresurser
Sammanslagna omfång (expanderas automatiskt)
Särskilda
Typiska kombinationer: Tredjeparts-”inloggning med ett klick” =openid profile; MCP / IDE-klienter som behöver automatiskt konfigurera Key =openid profile credentials:read credentials:write; fullständig administrationspanel =openid profile email platform offline_access.
Steg 1: Registrera en OAuth-app
Öppna auth.acedata.cloud/user/oauth-apps → ”Skapa app”, och fyll i:- Appnamn / beskrivning / logotyp: Visas på användarens sida för auktoriseringssamtycke.
- Klienttyp (Client Type):
- Konfidentiell (confidential) — du har en backend och kan lagra
client_secretsäkert (webbtjänster, backendtjänster). - Offentlig (public) — ren frontend / desktop / CLI / mobil, kan inte lagra hemligheter och måste använda PKCE.
- Konfidentiell (confidential) — du har en backend och kan lagra
- Återanropsadresser (Redirect URIs): Adressen som användaren omdirigeras tillbaka till när auktoriseringen är klar, måste vara exakt identisk med
redirect_urisom du skickar när du initierar auktoriseringen, och flera kan anges. - Behörighetsomfång (Scopes): Markera de scope du behöver från föregående avsnitt.
client_id; konfidentiella klienter visas dessutom client_secret endast en gång — spara den omedelbart, eftersom den inte kan visas igen efter att du stängt sidan (du kan generera en ny på detaljsidan via ”Rotate Secret”, då blir den gamla hemligheten omedelbart ogiltig).
Varje konto kan som mest skapa 20 OAuth-appar.
Steg 2: Omdirigera användaren till auktoriseringssidan
I din applikation omdirigerar du användarens webbläsare till auktoriseringssidan med följande frågeparametrar:state: En slumpmässig sträng som du själv genererar och som skickas tillbaka oförändrad vid återanropet, för att skydda mot CSRF; måste valideras.- PKCE (obligatoriskt för offentliga klienter, rekommenderas även för konfidentiella klienter): Generera först en slumpmässig
code_verifier, och beräkna sedancode_challenge = BASE64URL( SHA256( code_verifier ) ), läggcode_challengei auktoriserings-URL:en, och behåll självcode_verifierför användning i steg 4.
<redirect_uri>?error=access_denied&error_description=...&state=....
Auktoriseringskoden är giltig i 10 minuter och kan endast användas en gång.
Steg 3: Byt auktoriseringskoden mot token
I din backend (konfidentiell klient) eller klient (offentlig PKCE-klient) anropar du tokenändpunkten medcode.
Konfidentiell klient (med client_secret):
refresh_token visas endast om offline_access har begärts):
access_token är en JWT som innehåller scope-deklarationen; giltighetstiden är 15 dagar (antalet sekunder i expires_in). Refresh Token har en giltighetstid på 30 dagar.
Steg 4: Anropa gränssnitt med Access Token
Lägg bara token iAuthorization: Bearer-huvudet.
Läs användarinformation (UserInfo, fälten filtreras enligt auktoriserade scope):
platform.acedata.cloud, auktorisering enligt scope). Till exempel om credentials:read har beviljats:
scope-deklarationen i JWT:n — token kan endast komma åt resurser som användaren har auktoriserat. Om en obehörig resurs nås returneras 403.
Uppdatera token
När Access Token har löpt ut, använd Refresh Token för att byta till ett nytt tokenpar (kräver attoffline_access begärdes från början):
Återkalla token
Verkligt exempel: så här är våra egna MCP-servrar anslutna
Ace Data Clouds fler än 15 MCP-servrar (NanoBanana, Midjourney, Suno, Seedance, Kling…) använder just detta flöde för anslutningen ”Sign in with Ace Data Cloud” som visas i Claude Desktop / Cursor: de är alla registrerade som OAuth-appar av typen offentlig (PKCE), begär scope relaterade tillcredentials, och efter att användaren har auktoriserat dem kan MCP-servern anropa api.acedata.cloud på användarens vägnar — utan att användaren behöver klistra in en API Key manuellt. Din anslutning är exakt densamma som deras.
Vanliga fel
Felsvar har enhetligt formatet{ "error": "<code>", "error_description": "<mänskligt läsbar beskrivning>" }:
Snabböversikt över begränsningar
Bädda in en OAuth-app från tredje part på Studios startsida
Studios ”Inställningar → Startsida → Webbplatskomponenter” kan aktivera OAuth och konfigurera tredje parts appsclient_id och registrerade återanropsadress.
Webbplatsen och återanropet måste använda HTTPS, ha samma ursprung (protokoll, domännamn och port) och använda ett annat ursprung än Studio.
client_secret får inte fyllas i i konfigurationen; appens hemlighet får endast lagras i tredje partens backend.
Komponenten begär behörigheterna profile:read credentials:read. Varje besökare måste samtycka separat; att webbplatsägaren konfigurerar komponenten innebär inte att besökarna auktoriserar den.
Tredje partens sida genererar ett slumpmässigt state och en PKCE verifier, och skickar en S256 challenge till Studio. Studio är värd för den officiella auktoriseringssidan i komponentområdet,
och efter att användaren har samtyckt får tredje part en engångsauktoriseringskod och anropar token-slutpunkten för att byta den mot en OAuth access token, och läser därefter
GET https://platform.acedata.cloud/api/v1/credentials/?user_id=<用户ID> för att läsa befintliga API Key.
Användar-ID:t kommer från id som returneras av föregående steg GET https://auth.acedata.cloud/api/v1/users/me; gränssnittet för credential-listan accepterar inte user_id=me.
Studio överför inte sin egen inloggningstoken till tredje part och läser inte heller direkt användarens Key och injicerar den.
Offentliga klienter måste använda S256 PKCE. Vid byte till token måste redirect_uri skickas med och vara exakt samma som i auktoriseringsbegäran.
Auktoriseringskoden kan endast lösas in en gång. Före auktorisering kontrolleras om återanropsadressen har registrerats.
Tredje partens sida måste implementera meddelandeprotokollet; en befintlig godtycklig webbsida kan inte anslutas automatiskt bara genom att fylla i en URL.
Se det fullständiga exemplet i Guide för Studio OAuth-komponentintegration.
Att auktorisera läsning av API Key innebär att tillåta tredje part att spara och använda denna Key. Att återkalla OAuth-auktoriseringen gör inte en Key som tredje part redan har kopierat ogiltig;
användaren måste dessutom återkalla eller rotera Key.
