Source: https://ailoot.ai/docs/fi/cabinet/keys/ Canonical: https://ailoot.ai/docs/fi/cabinet/keys/ Language: fi [Hallintapaneelin API](https://ailoot.ai/docs/fi/) # API-avaimet [Markdown](https://ailoot.ai/docs/fi/cabinet/keys/index.md) Metodit, pyyntöjen kentät ja vastaukset. Osiossa on 5 metodia. Avaa metodi nähdäksesi käyttöoikeusehdot, pyynnön kentät ja vastauksen. | Metodi ja polku | Kuvaus | Käyttöoikeus | | --- | --- | --- | | `GET /api/v1/keys` | Luettelo — API-avaimet | Hallintapaneelin token | | `POST /api/v1/keys` | API-avaimen luominen | Hallintapaneelin token | | `DELETE /api/v1/keys/:id` | Poistaminen — API-avaimet | Hallintapaneelin token | | `GET /api/v1/keys/:id` | Hakeminen tunnisteella — API-avaimet | Hallintapaneelin token | | `PUT /api/v1/keys/:id` | API-avaimen muuttaminen | Hallintapaneelin token | **GET /api/v1/keys** — Luettelo — API-avaimet Käyttöoikeus: hallintapaneelin token GET`/api/v1/keys` Lukutoiminto; ID otetaan aiemmasta vastauksestasi ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys" \ -H "Authorization: Bearer $TOKEN" ``` ## Kyselyparametrit | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `sort_by` | `string` | ei | ; oletus: created\_at | | `sort_order` | `string` | ei | ; oletus: desc | | `search` | `string` | ei | | | `status` | `string` | ei | | | `page` | `integer` | ei | ; oletus: 1; positiivinen arvo; page\_size/limit \<=1000 | | `page_size` | `integer` | ei | ; oletus: 20; positiivinen arvo; page\_size/limit \<=1000 | | `limit` | `integer` | ei | ; oletus: 20; positiivinen arvo; page\_size/limit \<=1000 | Pyynnön runkoa ei tarvita. Lähetä yllä luetellut parametrit URLissa. ## Vastaus JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa. Vastauksen tietoskeemat: `APIKey`. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta. Vastauksen skeema, arvot ovat esimerkinomaisia ```json { "code": 0, "message": "success", "data": { "items": [ { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } ], "total": "PLACEHOLDER_TOTAL (integer)", "page": "PLACEHOLDER_PAGE (integer)", "page_size": "PLACEHOLDER_PAGE_SIZE (integer)", "pages": "PLACEHOLDER_PAGES (integer)" } } ``` Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin. Huomioitavaa: Vastaus sisältää salaisen key-arvon; älä julkaise oikeita arvoja. **POST /api/v1/keys** — API-avaimen luominen Käyttöoikeus: hallintapaneelin token POST`/api/v1/keys` ## JSON- / lomakekentät | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `name` | `string` | kyllä | required | | `custom_key` | `string` | ei | ; Valinnainen oma avainarvo; voi olla null | | `ip_whitelist` | `array` | ei | ; Sallittujen IP-osoitteiden luettelo | | `ip_blacklist` | `array` | ei | ; Estettyjen IP-osoitteiden luettelo | | `quota` | `number` | ei | ; Avaimen kulutusraja USD:na; voi olla null | | `expires_in_days` | `integer` | ei | ; Voimassaoloaika päivinä; voi olla null | | `rate_limit_5h` | `number` | ei | ; voi olla null | | `rate_limit_1d` | `number` | ei | ; voi olla null | | `rate_limit_7d` | `number` | ei | ; voi olla null | Pyynnön rungon mallipohja ```json { "name": "PLACEHOLDER_NAME (string)", "custom_key": "PLACEHOLDER_CUSTOM_KEY (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "quota": "PLACEHOLDER_QUOTA (number)", "expires_in_days": "PLACEHOLDER_EXPIRES_IN_DAYS (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)" } ``` PLACEHOLDER merkitsee omaa syötettäsi ja sen tyyppiä. Korvaa arvot ja säilytä vain tarvitsemasi valinnaiset kentät; merkkijonomerkkejä ei lähetetä lukujen, boolean-arvojen, objektien tai taulukoiden sijaan. Pyynnön skeema: `CreateAPIKeyRequest` ## Vastaus JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa. Vastauksen tietoskeemat: `APIKey`. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta. Vastauksen skeema, arvot ovat esimerkinomaisia ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin. Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta. Huomioitavaa: Idempotency-Key on tuettu; toisto palauttaa tallennetun vastauksen ja X-Idempotency-Replayed-otsakkeen. Huomioitavaa: Vastaus sisältää salaisen key-arvon; älä julkaise oikeita arvoja. Metodi muuttaa tietoja. Uudelleenlähetys on turvallinen vain, jos metodin kohdalla ilmoitetaan Idempotency-Key. Jos vastaus katoaa, tarkista ensin tulos (esimerkiksi avainluettelo) ja päätä vasta sitten, lähetätkö pyynnön uudelleen. **DELETE /api/v1/keys/:id** — Poistaminen — API-avaimet Käyttöoikeus: hallintapaneelin token DELETE`/api/v1/keys/:id` ## Polkuparametrit | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `id` | `integer` | kyllä | | Pyynnön runkoa ei tarvita. ## Vastaus JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa. Vastauksen skeema, arvot ovat esimerkinomaisia ```json { "code": 0, "message": "success", "data": { "message": "VALUE_FROM_RESPONSE" } } ``` Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin. Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta. Huomioitavaa: Vastaus sisältää salaisen key-arvon; älä julkaise oikeita arvoja. Metodi muuttaa tietoja. Uudelleenlähetys on turvallinen vain, jos metodin kohdalla ilmoitetaan Idempotency-Key. Jos vastaus katoaa, tarkista ensin tulos (esimerkiksi avainluettelo) ja päätä vasta sitten, lähetätkö pyynnön uudelleen. **GET /api/v1/keys/:id** — Hakeminen tunnisteella — API-avaimet Käyttöoikeus: hallintapaneelin token GET`/api/v1/keys/:id` Lukutoiminto; ID otetaan aiemmasta vastauksestasi ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys/$ID" \ -H "Authorization: Bearer $TOKEN" ``` ## Polkuparametrit | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `id` | `integer` | kyllä | | Pyynnön runkoa ei tarvita. Lähetä yllä luetellut parametrit URLissa. ## Vastaus JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa. Vastauksen tietoskeemat: `APIKey`. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta. Vastauksen skeema, arvot ovat esimerkinomaisia ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin. Huomioitavaa: Vastaus sisältää salaisen key-arvon; älä julkaise oikeita arvoja. **PUT /api/v1/keys/:id** — API-avaimen muuttaminen Käyttöoikeus: hallintapaneelin token PUT`/api/v1/keys/:id` ## Polkuparametrit | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `id` | `integer` | kyllä | | ## JSON- / lomakekentät | Kenttä | Tyyppi | Pakollinen | Tarkistus / kuvaus | | --- | --- | --- | --- | | `name` | `string` | ei | | | `status` | `string` | ei | omitempty,oneof=active inactive | | `ip_whitelist` | `array` | ei | ; Sallitut IP-osoitteet: null ei muuta luetteloa, tyhjä taulukko tyhjentää sen; voi olla null | | `ip_blacklist` | `array` | ei | ; Estetyt IP-osoitteet: null ei muuta luetteloa, tyhjä taulukko tyhjentää sen; voi olla null | | `quota` | `number` | ei | ; Avaimen kulutusraja USD:na; 0 — ei rajaa; voi olla null | | `expires_at` | `string` | ei | ; Voimassaolon päättymisaika ISO 8601 -muodossa; voi olla null | | `reset_quota` | `boolean` | ei | ; Nollaa kulutusrajasta käytetty osuus; voi olla null | | `rate_limit_5h` | `number` | ei | ; voi olla null | | `rate_limit_1d` | `number` | ei | ; voi olla null | | `rate_limit_7d` | `number` | ei | ; voi olla null | | `reset_rate_limit_usage` | `boolean` | ei | ; Nollaa jaksojen rajoihin laskettu kulutus; voi olla null | Pyynnön rungon mallipohja ```json { "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "quota": "PLACEHOLDER_QUOTA (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "reset_quota": "PLACEHOLDER_RESET_QUOTA (boolean)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "reset_rate_limit_usage": "PLACEHOLDER_RESET_RATE_LIMIT_USAGE (boolean)" } ``` PLACEHOLDER merkitsee omaa syötettäsi ja sen tyyppiä. Korvaa arvot ja säilytä vain tarvitsemasi valinnaiset kentät; merkkijonomerkkejä ei lähetetä lukujen, boolean-arvojen, objektien tai taulukoiden sijaan. Pyynnön skeema: `UpdateAPIKeyRequest` ## Vastaus JSON-vastaus sisältää code-, message- ja data-kentät. data-kentän sisältö kuvataan alla olevissa skeemoissa. Vastauksen tietoskeemat: `APIKey`. Kentät ja tyypit löytyvät ”Tietoskeemat”-sivuilta. Vastauksen skeema, arvot ovat esimerkinomaisia ```json { "code": 0, "message": "success", "data": { "id": "PLACEHOLDER_ID (integer)", "user_id": "PLACEHOLDER_USER_ID (integer)", "key": "PLACEHOLDER_KEY (string)", "name": "PLACEHOLDER_NAME (string)", "status": "PLACEHOLDER_STATUS (string)", "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)", "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)", "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)", "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)", "quota": "PLACEHOLDER_QUOTA (number)", "quota_used": "PLACEHOLDER_QUOTA_USED (number)", "expires_at": "PLACEHOLDER_EXPIRES_AT (string)", "created_at": "PLACEHOLDER_CREATED_AT (string)", "updated_at": "PLACEHOLDER_UPDATED_AT (string)", "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)", "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)", "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)", "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)", "usage_5h": "PLACEHOLDER_USAGE_5H (number)", "usage_1d": "PLACEHOLDER_USAGE_1D (number)", "usage_7d": "PLACEHOLDER_USAGE_7D (number)", "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)", "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)", "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)", "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)", "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)", "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)", "user": "PLACEHOLDER_USER (object)" } } ``` Huomioitavaa: Kaikki henkilötiedot ja objektit rajataan JWT:n subjektiin. Huomioitavaa: Toiminto muuttaa tilaa tai jatkaa kertakäyttöistä valtuutusta; esimerkki kuvaa sopimuksen eikä sitä suoriteta. Huomioitavaa: Vastaus sisältää salaisen key-arvon; älä julkaise oikeita arvoja. Huomioitavaa: Niin kauan kuin avaimella on keskeneräisiä pyyntöjä varauksineen, sen kulutusrajaa ei voi pienentää tai nollata. Lähetä vain muuttamasi kentät. Metodi muuttaa tietoja. Uudelleenlähetys on turvallinen vain, jos metodin kohdalla ilmoitetaan Idempotency-Key. Jos vastaus katoaa, tarkista ensin tulos (esimerkiksi avainluettelo) ja päätä vasta sitten, lähetätkö pyynnön uudelleen. Onko vielä kysyttävää? Lähetä Request ID ja kuvaus — autamme selvittämään asian.[Ota yhteyttä tukeen](mailto:support@ailoot.ai) ## Ailoot · Yritys ja sen projektisalkku Ailoot perustuu kertyneeseen toimintakokemukseen, laajaan asiakaskuntaan, vakaaseen palveluun ja jatkuvaan KPI-seurantaan. Yritys ja sen projektisalkku: miljoonia asiakkaita; kuukausittainen myynti miljardiluokassa. Ailoot hyödyntää tätä toimintakokemusta tarjotessaan API-yhteyden tekoälytoimintoihin asiakkaiden tuotteissa, agenteissa, sovelluksissa ja automaatioissa.