API dokumentatsioon

Loo Kicki autoriseerimisvooge, vaata õigusi ja halda tokeneid v2 API kaudu.

Laadi OpenAPI alla

Autoriseerimisvoog

  1. Vaata õiguste kataloogi ja vali oma integratsioonile vajalike aktiivsete õiguste ID-d.
  2. Loo voog. Hoia selle pärimisvõti privaatsena ja ava authorization_url konto omaniku brauseris.
  3. Pärast autoriseerimist päri mandaadid üks kord. Salvesta pääsutoken ja uusim värskendustoken.

Vood aeguvad 24 tunni pärast. Edukas pärimine kulutab salvestatud mandaadid. Ootel autoriseerimise kontrollimiste vahel oota vähemalt viis sekundit.

Autentimine ja piirangud

Mandaatide pärimiseks kasutatakse voo privaatvõtit Bearer-mandaadina. Teised lõpp-punktid kasutavad alltoodud sisendeid. V2 API lubab 120 päringut minutis ühe IP kohta; HTTP 429 tähendab limiidi täitumist.

Lõpp-punktide teatmik

GET /api/v2/scopes

Tokeni saadaolevad õigused

Vaata praeguste õiguste ID-sid, nimesid, kirjeldusi ja saadavust. See päring ei vaja mandaate.

Sellel lõpp-punktil ei ole päringuparameetreid.

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "scopes": [
    {
      "description": "Send chat messages as the authorized account.",
      "id": 6,
      "scope": "chat:write",
      "secret": false
    }
  ],
  "success": true
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
POST /api/v2/workflows

Loo autoriseerimisvoog

Loo 24 tundi kehtiv volitustöövoog. Kasuta lubatud jagatud režiimi või oma rakenduse tunnuseid POST-päringu sisus.

Parameetrid

ai_agentValikuline

string · keha

Valikuline tehisintellekti kliendi nimi, kuni 64 UTF-8 baiti ilma juhtmärkideta. See on päritolu märkimiseks, mitte autentimiseks.

credentialsValikuline

object · keha

Kasuta oma Kicki arendajarakendust. Jäta mõlemad väljad tühjaks ainult siis, kui jagatud režiim on saadaval. Tunnused säilivad vahelehe mälus ja volitamise ajal ajutiselt krüpteerituna serveris.

is_aiValikuline

boolean · keha

Märgi voog tehisintellekti abiga toimuvaks.

redirect_urlValikuline

string · keha

Valikuline täielik HTTP- või HTTPS-sihtaadress pärast autoriseerimist. URL ei tohi sisaldada mandaate.

scope_idsValikuline

array · keha

Kataloogi numbrilised ID-d. Vali aktiivsed õigused, kuni 150 erinevat õigust.

scopesValikuline

array · keha

Komadega eraldatud õiguste nimed. Parameeter peab olema olemas; tühi väärtus ei taotle õigusi.

titleValikuline

string · keha

Rakenduse nimi, kuni 500 UTF-8 baiti.

Päringu JSON-keha

{
  "credentials": {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  },
  "scope_ids": [
    6
  ],
  "title": "Example integration"
}

Vastus

HTTP 201
Loodud
application/json
Näidisvastus
{
  "authorization_url": "https://kicktokengen.com/authorize/EXAMPLE_ID",
  "expires_at": "2030-01-02T12:00:00Z",
  "id": "EXAMPLE_ID",
  "retrieval_key": "EXAMPLE_PRIVATE_KEY",
  "status_url": "https://kicktokengen.com/api/v2/workflows/EXAMPLE_ID",
  "success": true
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
GET /api/v2/workflows/{id}

Päri voo mandaadid

Tagastab mandaadid ühe korra pärast autoriseerimist. Saada voo pärimisvõti Bearer-mandaadina. Edukas lugemine kulutab salvestatud mandaadid.

Parameetrid

idKohustuslik

string · tee

Voo loomisel tagastatud ID.

AuthorizationKohustuslik

Bearer · päis

Voo loomisel tagastatud privaatne pärimisvõti. Ära lisa seda avalikesse linkidesse.

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "access_token": "EXAMPLE_ACCESS_TOKEN",
  "client_id": "EXAMPLE_CLIENT_ID",
  "expires_at": "2030-01-01T13:00:00Z",
  "expires_in": 3600,
  "refresh_token": "EXAMPLE_REFRESH_TOKEN",
  "scopes": [
    "chat:write"
  ],
  "status": "authorized",
  "success": true,
  "token_type": "Bearer"
}
HTTP 202
Autoriseerimine on veel ootel
application/json
Näidisvastus
{
  "status": "pending",
  "success": false
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 410
Mandaadid on aegunud või juba päritud
application/json
Näidisvastus
{
  "message": "workflow credentials are no longer available",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
GET /api/v2/ai/workflows/create

Loo tehisintellekti voog GET-päringuga

GET-alternatiiv klientidele, mis saavad ainult URL-e lugeda. Loob voo õiguste nimede põhjal ja tagastab privaatse pärimis-URL-i. JSON-vastus antakse kujul text/plain.

Parameetrid

titleValikuline

string · päring

Rakenduse nimi, kuni 500 UTF-8 baiti.

scopesValikuline

string · päring

Komadega eraldatud õiguste nimed. Parameeter peab olema olemas; tühi väärtus ei taotle õigusi.

scope_idsValikuline

string · päring

Kataloogi numbrilised ID-d. Vali aktiivsed õigused, kuni 150 erinevat õigust.

ai_agentValikuline

string · päring

Valikuline tehisintellekti kliendi nimi, kuni 64 UTF-8 baiti ilma juhtmärkideta. See on päritolu märkimiseks, mitte autentimiseks.

Vastus

HTTP 201
Loodud
application/json
Näidisvastus
{
  "authorization_url": "https://kicktokengen.com/authorize/EXAMPLE_ID",
  "id": "EXAMPLE_ID",
  "retrieval_url": "https://kicktokengen.com/api/v2/ai/workflows/EXAMPLE_ID/EXAMPLE_PRIVATE_KEY",
  "success": true
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
GET /api/v2/ai/workflows/{id}/{key}

Päri tehisintellekti mandaadid GET-päringuga

Privaatne URL sisaldab laadimisvõtit. JSON-vastus annab tunnused ühe korra; kaitse kogu URL-i nagu parooli.

Parameetrid

idKohustuslik

string · tee

Voo loomisel tagastatud ID.

keyKohustuslik

string · tee

Voo loomisel tagastatud privaatne pärimisvõti. Ära lisa seda avalikesse linkidesse.

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "access_token": "EXAMPLE_ACCESS_TOKEN",
  "client_id": "EXAMPLE_CLIENT_ID",
  "expires_at": "2030-01-01T13:00:00Z",
  "expires_in": 3600,
  "refresh_token": "EXAMPLE_REFRESH_TOKEN",
  "scopes": [
    "chat:write"
  ],
  "status": "authorized",
  "success": true,
  "token_type": "Bearer"
}
HTTP 202
Autoriseerimine on veel ootel
application/json
Näidisvastus
{
  "status": "pending",
  "success": false
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 410
Mandaadid on aegunud või juba päritud
application/json
Näidisvastus
{
  "message": "workflow credentials are no longer available",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
POST /api/v2/tokens/validate

Kontrolli tokenit

Kontrolli kehtivust ning näita Kicki tagastatud väljastajarakendust, tüüpi, õigusi ja aegumist.

Parameetrid

access_tokenKohustuslik

string · keha

Kontrollitav või tühistatav Kicki pääsutoken ilma oauth: eesliiteta.

Päringu JSON-keha

{
  "access_token": "EXAMPLE_ACCESS_TOKEN"
}

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "active": true,
  "client_id": "EXAMPLE_CLIENT_ID",
  "exp": 1893502800,
  "expires_in": 3600,
  "scope_details": [
    {
      "description": "Send chat messages.",
      "scope": "chat:write"
    }
  ],
  "scopes": [
    "chat:write"
  ],
  "success": true,
  "token_type": "user"
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid access token",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
POST /api/v2/tokens/refresh

Värskendustoken

Uuendab pääsutokenit värskendustokeni abil. Oma Kicki rakenduse tokeni puhul anna nii client_id kui ka client_secret.

Parameetrid

client_idValikuline

string · keha

Kicki rakenduse kliendi-ID. KTG jagatud rakenduse kasutamiseks jäta see välja.

client_secretValikuline

string · keha

Kicki rakenduse kliendisaladus. Värskendamisel anna see koos client_id väärtusega.

refresh_tokenKohustuslik

string · keha

Konto ja Kicki rakenduse uusim värskendustoken.

Päringu JSON-keha

{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "refresh_token": "EXAMPLE_REFRESH_TOKEN"
}

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "access_token": "EXAMPLE_ACCESS_TOKEN",
  "client_id": "EXAMPLE_CLIENT_ID",
  "expires_at": "2030-01-01T13:00:00Z",
  "expires_in": 3600,
  "refresh_token": "EXAMPLE_REFRESH_TOKEN",
  "scopes": [
    "chat:write"
  ],
  "status": "authorized",
  "success": true,
  "token_type": "Bearer"
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid refresh token or client credentials",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
POST /api/v2/tokens/revoke

Tühista token

Tühista üks POST-päringu sisus antud pääsu- või värskendustoken.

Parameetrid

access_tokenValikuline

string · keha

Kontrollitav või tühistatav Kicki pääsutoken ilma oauth: eesliiteta.

refresh_tokenValikuline

string · keha

Konto ja Kicki rakenduse uusim värskendustoken.

Päringu JSON-keha

{
  "access_token": "EXAMPLE_ACCESS_TOKEN"
}

Vastus

HTTP 200
Edukas vastus
application/json
Näidisvastus
{
  "revoked": true,
  "success": true
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid token request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti
POST /api/v2/token-requests

Taotle tokenit

Loob autoriseerimistaotluse lingi. Pärast konto omaniku autoriseerimist saadetakse mandaadid aadressile my_email.

Parameetrid

credentialsValikuline

object · keha

Kasuta oma Kicki arendajarakendust. Jäta mõlemad väljad tühjaks ainult siis, kui jagatud režiim on saadaval. Tunnused säilivad vahelehe mälus ja volitamise ajal ajutiselt krüpteerituna serveris.

my_emailKohustuslik

string · keha

E-posti aadress, kuhu mandaadid saadetakse pärast taotluse täitmist.

my_nameKohustuslik

string · keha

Taotleja nimi, kuni 128 UTF-8 baiti.

scope_idsValikuline

array · keha

Kataloogi numbrilised ID-d. Vali aktiivsed õigused, kuni 150 erinevat õigust.

scopesValikuline

array · keha

Komadega eraldatud õiguste nimed. Parameeter peab olema olemas; tühi väärtus ei taotle õigusi.

Päringu JSON-keha

{
  "credentials": {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  },
  "my_email": "developer@example.com",
  "my_name": "Example developer",
  "scope_ids": [
    6
  ]
}

Vastus

HTTP 201
Loodud
application/json
Näidisvastus
{
  "expires_at": "2030-01-02T12:00:00Z",
  "success": true,
  "url": "https://kicktokengen.com/request/EXAMPLE_ID"
}
HTTP 400
Vigane päring
application/json
Näidisvastus
{
  "message": "invalid request",
  "success": false
}
HTTP 401
Vigane token või pärimisvõti
application/json
Näidisvastus
{
  "message": "invalid retrieval key",
  "success": false
}
HTTP 429
Päringulimiit on täis
application/json
Näidisvastus
{
  "message": "rate limit exceeded",
  "success": false
}
HTTP 503
Teenus pole ajutiselt saadaval
application/json
Näidisvastus
{
  "message": "Service unavailable",
  "success": false
}
Proovi lõpp-punkti