API käyttää todentamiseen OAuth 2.0 -protokollaa ja PKCE-laajennusta.
VaroitusBasic-todentaminen on vanhentunut, ja se poistetaan tulevassa päivityksessä. Siirry käyttämään OAuth 2.0:aa.
client_id-tunnuksenUseimmat OAuth 2.0 -asiakaskirjastot hoitavat tämän työnkulun automaattisesti, kun annat niille palvelimen metatietopäätepisteen /.well-known/oauth-authorization-server.
Kaikkien alla olevien päätepisteiden perusosoite on https://api.attendium.com.
Luo Attendiumissa OAuth-sovellus, niin saat client_id-tunnuksesi ja, jos kyseessä on luottamuksellinen sovellus, myös client_secret-salaisuutesi. Sinun tarvitsee tehdä tämä vain kerran sovellusta kohden. Katso OAuth-sovellukset.
Uudelleenohjaus-URI:n on käytettävä https-protokollaa tai paikallisessa kehityksessä http-protokollaa ja loopback-osoitetta (localhost, 127.0.0.1 tai ::1). Julkinen sovellus voi käyttää myös yksityiskäyttöistä URI-skeemaa käänteisessä verkkotunnusmuodossa, kuten com.example.app:/oauth/callback.
Kun luot OAuth-sovelluksen – joko Attendiumissa tai asiakasohjelman dynaamisella rekisteröinnillä – hyväksyt kehittäjäehtojen sillä hetkellä julkaistun version.
Luo PKCE-koodin todentaja ja koodihaaste:
A-Z, a-z, 0-9, -, ., _, ~) – tämä on code_verifier-arvosicode_challenge-arvosiOhjaa sitten käyttäjä osoitteeseen:
GET /oauth2/authorize?response_type=code
&client_id=your-client-id
&redirect_uri=https://yourapp.example.com/callback
&code_challenge=your-code-challenge
&code_challenge_method=S256
&state=random-state-value
Käyttäjä kirjautuu sisään Attendiumiin, ja hänet ohjataan takaisin redirect_uri-osoitteeseesi valtuutuskoodin (code) ja state-arvosi kanssa.
POST /oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&client_id=your-client-id
&redirect_uri=https://yourapp.example.com/callback
&code=the-authorization-code
&code_verifier=your-code-verifier
Luottamuksellisen sovelluksen on myös todennettava itsensä joko Basic-todentamisella (client_secret_basic) tai lähettämällä client_secret pyynnön rungossa (client_secret_post):
POST /oauth2/token
Authorization: Basic base64(your-client-id:your-client-secret)
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&redirect_uri=https://yourapp.example.com/callback
&code=the-authorization-code
&code_verifier=your-code-verifier
Vastaus sisältää access_token- ja refresh_token-arvot.
Lisää käyttöoikeustunnus Authorization-otsakkeeseen:
curl -H "Authorization: Bearer your-access-token" \
-H "Content-Type: application/json" \
-d '{"query": "{ me { id } }"}' \
https://api.attendium.com/graphql
Tunnuspyynnön vastauksessa on expires_in-kenttä, joka kertoo, kuinka kauan käyttöoikeustunnus on voimassa. Hae päivitystunnuksella uusi käyttöoikeustunnus ennen kuin nykyinen vanhenee:
POST /oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token
&client_id=your-client-id
&refresh_token=your-refresh-token
Luottamuksellinen sovellus todentaa tämän pyynnön samalla tavalla kuin valtuutuskoodin vaihdossa.
Sovellukset, jotka määrittävät itsensä palvelimen metatietojen perusteella – myös MCP:n kautta yhdistävät tekoälyavustajat (katso MCP:n käyttöönotto) – rekisteröityvät lähettämällä POST-pyynnön osoitteeseen /oauth2/register. Et tarvitse tätä, jos luot OAuth-sovelluksesi Attendiumissa.
POST /oauth2/register
Content-Type: application/json
{
"redirect_uris": ["https://yourapp.example.com/callback"],
"client_name": "Oma sovellus"
}
Näin rekisteröity sovellus ei näy kohdassa ”OAuth-sovellukset”, joten sen nimeä, uudelleenohjaus-URI-osoitteita ja asiakasohjelman salaisuutta ei voi muuttaa siellä.