API-ohjeet

Tokenin käytettävissä olevat oikeudet

Lue nykyisten oikeuksien tunnisteet, nimet, kuvaukset ja saatavuus. Pyyntö ei vaadi tunnistetietoja.

Tällä päätepisteellä ei ole pyyntöparametreja.

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "scopes": [
    {
      "description": "Send chat messages as the authorized account.",
      "id": 6,
      "scope": "chat:write",
      "secret": false
    }
  ],
  "success": true
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Luo valtuutusprosessi

Luo vuorokauden voimassa olevan valtuutustyönkulun. Käytä käytössä olevaa jaettua tilaa tai oman sovelluksesi tunnuksia POST-rungossa.

Parametrit

ai_agentValinnainen

string · runko

Valinnainen tekoälyasiakkaan nimi, enintään 64 UTF-8-tavua ilman ohjausmerkkejä. Käytetään alkuperän nimeämiseen, ei todennukseen.

credentialsValinnainen

object · runko

Käytä omaa Kick-kehittäjäsovellusta. Jätä molemmat kentät tyhjiksi vain jaetun tilan ollessa käytettävissä. Tunnukset säilyvät välilehden muistissa ja salattuina palvelimella valtuutuksen ajan.

is_aiValinnainen

boolean · runko

Merkitse prosessi tekoälyavusteiseksi.

redirect_urlValinnainen

string · runko

Valinnainen täydellinen HTTP- tai HTTPS-kohde valtuutuksen jälkeen. URL-osoite ei saa sisältää tunnistetietoja.

scope_idsValinnainen

array · runko

Luettelon numeeriset tunnisteet. Valitse aktiivisia oikeuksia, enintään 150 erilaista.

scopesValinnainen

array · runko

Pilkuin erotetut oikeuksien nimet. Parametri on annettava; tyhjä arvo ei pyydä oikeuksia.

titleValinnainen

string · runko

Sovelluksen nimi, enintään 500 UTF-8-tavua.

Pyynnön JSON-runko

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

Vastaus

HTTP 201

Luotu
application/json

Esimerkkivastaus

{
  "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

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Nouda prosessin tunnistetiedot

Palauttaa tunnistetiedot kerran valtuutuksen jälkeen. Lähetä prosessin noutoavain Bearer-tunnisteena. Onnistunut luku kuluttaa tallennetut tunnistetiedot.

Parametrit

idPakollinen

string · polku

Prosessin luonnin yhteydessä palautettu tunniste.

AuthorizationPakollinen

Bearer · otsake

Prosessin luonnissa palautettu yksityinen noutoavain. Älä sisällytä sitä julkisiin linkkeihin.

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "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

Valtuutus on vielä kesken
application/json

Esimerkkivastaus

{
  "status": "pending",
  "success": false
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 410

Tunnistetiedot vanhenivat tai ne on jo noudettu
application/json

Esimerkkivastaus

{
  "message": "workflow credentials are no longer available",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Luo vain GET-pyyntöjä käyttävä tekoälyprosessi

GET-vaihtoehto asiakkaille, jotka voivat vain lukea URL-osoitteita. Luo prosessin oikeuksien nimillä ja palauttaa yksityisen nouto-osoitteen. JSON-vastaus tarjotaan muodossa text/plain.

Parametrit

titleValinnainen

string · kysely

Sovelluksen nimi, enintään 500 UTF-8-tavua.

scopesValinnainen

string · kysely

Pilkuin erotetut oikeuksien nimet. Parametri on annettava; tyhjä arvo ei pyydä oikeuksia.

scope_idsValinnainen

string · kysely

Luettelon numeeriset tunnisteet. Valitse aktiivisia oikeuksia, enintään 150 erilaista.

ai_agentValinnainen

string · kysely

Valinnainen tekoälyasiakkaan nimi, enintään 64 UTF-8-tavua ilman ohjausmerkkejä. Käytetään alkuperän nimeämiseen, ei todennukseen.

Vastaus

HTTP 201

Luotu
application/json

Esimerkkivastaus

{
  "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

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Nouda tekoälyn tunnistetiedot GET-pyynnöllä

Yksityinen URL sisältää noutoavaimen. JSON-vastaus luovuttaa tunnukset kerran; suojaa koko URL salasanan tavoin.

Parametrit

idPakollinen

string · polku

Prosessin luonnin yhteydessä palautettu tunniste.

keyPakollinen

string · polku

Prosessin luonnissa palautettu yksityinen noutoavain. Älä sisällytä sitä julkisiin linkkeihin.

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "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

Valtuutus on vielä kesken
application/json

Esimerkkivastaus

{
  "status": "pending",
  "success": false
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 410

Tunnistetiedot vanhenivat tai ne on jo noudettu
application/json

Esimerkkivastaus

{
  "message": "workflow credentials are no longer available",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Tarkista token

Tarkista voimassaolo ja näytä Kickin palauttama myöntäjäsovellus, tyyppi, oikeudet ja vanheneminen.

Parametrit

access_tokenPakollinen

string · runko

Tarkistettava tai peruutettava Kick-käyttöoikeustoken ilman oauth:-etuliitettä.

Pyynnön JSON-runko

{
  "access_token": "EXAMPLE_ACCESS_TOKEN"
}

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "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

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid access token",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Päivitystunnus

Uudistaa käyttöoikeustokenin päivitystokenilla. Anna sekä client_id että client_secret, jos token kuuluu omaan Kick-sovellukseesi.

Parametrit

client_idValinnainen

string · runko

Kick-sovelluksen asiakastunniste. Jätä pois käyttääksesi KTG:n jaettua sovellusta.

client_secretValinnainen

string · runko

Kick-sovelluksen asiakassalaisuus. Anna päivityspyynnössä yhdessä client_id-arvon kanssa.

refresh_tokenPakollinen

string · runko

Tilin ja Kick-sovelluksen uusin päivitystoken.

Pyynnön JSON-runko

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

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "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

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid refresh token or client credentials",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Mitätöi token

Peru yksi POST-rungossa annettu pääsy- tai päivitystoken.

Parametrit

access_tokenValinnainen

string · runko

Tarkistettava tai peruutettava Kick-käyttöoikeustoken ilman oauth:-etuliitettä.

refresh_tokenValinnainen

string · runko

Tilin ja Kick-sovelluksen uusin päivitystoken.

Pyynnön JSON-runko

{
  "access_token": "EXAMPLE_ACCESS_TOKEN"
}

Vastaus

HTTP 200

Onnistunut vastaus
application/json

Esimerkkivastaus

{
  "revoked": true,
  "success": true
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid token request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Pikalinkki

Luo uudelleenkäytettävän linkin valituilla oikeustunnisteilla. auth=stay avaa generaattorin; auth=authorize aloittaa Kick-valtuutuksen.

Parametrit

authValinnainen

string · runko

stay avaa generaattorin. authorize ja yhteensopivuusalias auth_auth aloittavat valtuutuksen heti.

scope_idsValinnainen

array · runko

Luettelon numeeriset tunnisteet. Valitse aktiivisia oikeuksia, enintään 150 erilaista.

scopesValinnainen

array · runko

Pilkuin erotetut oikeuksien nimet. Parametri on annettava; tyhjä arvo ei pyydä oikeuksia.

Pyynnön JSON-runko

{
  "auth": "stay",
  "scope_ids": [
    6
  ]
}

Vastaus

HTTP 201

Luotu
application/json

Esimerkkivastaus

{
  "success": true,
  "url": "https://kicktokengen.com/quick/Ab3dEf8_"
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}

Pyydä token

Luo valtuutuspyyntölinkin. Kun tilin omistaja suorittaa valtuutuksen, tunnistetiedot lähetetään osoitteeseen my_email.

Parametrit

credentialsValinnainen

object · runko

Käytä omaa Kick-kehittäjäsovellusta. Jätä molemmat kentät tyhjiksi vain jaetun tilan ollessa käytettävissä. Tunnukset säilyvät välilehden muistissa ja salattuina palvelimella valtuutuksen ajan.

my_emailPakollinen

string · runko

Sähköpostiosoite, johon tunnistetiedot toimitetaan pyynnön valmistuttua.

my_namePakollinen

string · runko

Pyytäjän nimi, enintään 128 UTF-8-tavua.

scope_idsValinnainen

array · runko

Luettelon numeeriset tunnisteet. Valitse aktiivisia oikeuksia, enintään 150 erilaista.

scopesValinnainen

array · runko

Pilkuin erotetut oikeuksien nimet. Parametri on annettava; tyhjä arvo ei pyydä oikeuksia.

Pyynnön JSON-runko

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

Vastaus

HTTP 201

Luotu
application/json

Esimerkkivastaus

{
  "expires_at": "2030-01-02T12:00:00Z",
  "success": true,
  "url": "https://kicktokengen.com/request/EXAMPLE_ID"
}

HTTP 400

Virheellinen pyyntö
application/json

Esimerkkivastaus

{
  "message": "invalid request",
  "success": false
}

HTTP 401

Virheellinen token tai noutoavain
application/json

Esimerkkivastaus

{
  "message": "invalid retrieval key",
  "success": false
}

HTTP 429

Pyyntöraja saavutettu
application/json

Esimerkkivastaus

{
  "message": "rate limit exceeded",
  "success": false
}

HTTP 503

Palvelu on tilapäisesti poissa käytöstä
application/json

Esimerkkivastaus

{
  "message": "Service unavailable",
  "success": false
}