Source: https://ailoot.ai/docs/lt/cabinet/keys/ Canonical: https://ailoot.ai/docs/lt/cabinet/keys/ Language: lt [Paskyros API](https://ailoot.ai/docs/lt/) # API raktai [Markdown](https://ailoot.ai/docs/lt/cabinet/keys/index.md) Metodai, užklausų laukai ir atsakymai. Skiltyje yra 5 metodai. Atverkite metodą, kad peržiūrėtumėte prieigos sąlygas, užklausos laukus ir atsakymą. | Metodas ir kelias | Aprašymas | Prieiga | | --- | --- | --- | | `GET /api/v1/keys` | Sąrašas — API raktai | Paskyros žetonas | | `POST /api/v1/keys` | API rakto kūrimas | Paskyros žetonas | | `DELETE /api/v1/keys/:id` | Šalinimas — API raktai | Paskyros žetonas | | `GET /api/v1/keys/:id` | Gavimas pagal identifikatorių — API raktai | Paskyros žetonas | | `PUT /api/v1/keys/:id` | API rakto keitimas | Paskyros žetonas | **GET /api/v1/keys** — Sąrašas — API raktai Prieiga: paskyros žetonas GET`/api/v1/keys` Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys" \ -H "Authorization: Bearer $TOKEN" ``` ## Užklausos eilutės parametrai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `sort_by` | `string` | ne | ; numatytoji reikšmė: created\_at | | `sort_order` | `string` | ne | ; numatytoji reikšmė: desc | | `search` | `string` | ne | | | `status` | `string` | ne | | | `page` | `integer` | ne | ; numatytoji reikšmė: 1; positive; page\_size/limit \<=1000 | | `page_size` | `integer` | ne | ; numatytoji reikšmė: 20; positive; page\_size/limit \<=1000 | | `limit` | `integer` | ne | ; numatytoji reikšmė: 20; positive; page\_size/limit \<=1000 | Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL. ## Atsakymas JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose. Atsakymo duomenų schemos: `APIKey`. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“. Atsakymo schema, reikšmės pavyzdinės ```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)" } } ``` Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu. Ypatybės: atsakyme yra slaptas key; tikrų reikšmių neviešinkite. **POST /api/v1/keys** — API rakto kūrimas Prieiga: paskyros žetonas POST`/api/v1/keys` ## JSON / formos laukai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `name` | `string` | taip | required | | `custom_key` | `string` | ne | ; Neprivaloma nuosava rakto reikšmė; gali būti null | | `ip_whitelist` | `array` | ne | ; Leidžiamų IP sąrašas | | `ip_blacklist` | `array` | ne | ; Draudžiamų IP sąrašas | | `quota` | `number` | ne | ; Rakto išlaidų limitas USD; gali būti null | | `expires_in_days` | `integer` | ne | ; Galiojimo trukmė dienomis; gali būti null | | `rate_limit_5h` | `number` | ne | ; gali būti null | | `rate_limit_1d` | `number` | ne | ; gali būti null | | `rate_limit_7d` | `number` | ne | ; gali būti null | Užklausos turinio šablonas ```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 žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų. Užklausos schema: `CreateAPIKeyRequest` ## Atsakymas JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose. Atsakymo duomenų schemos: `APIKey`. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“. Atsakymo schema, reikšmės pavyzdinės ```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)" } } ``` Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu. Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas. Ypatybės: palaikomas Idempotency-Key; pakartojus grąžinamas išsaugotas atsakymas su X-Idempotency-Replayed. Ypatybės: atsakyme yra slaptas key; tikrų reikšmių neviešinkite. Metodas keičia duomenis. Pakartotinai siųsti saugu tik tada, kai prie metodo nurodytas Idempotency-Key. Jei atsakymas prarastas, pirmiausia patikrinkite rezultatą (pavyzdžiui, raktų sąrašą), tada spręskite, ar kartoti užklausą. **DELETE /api/v1/keys/:id** — Šalinimas — API raktai Prieiga: paskyros žetonas DELETE`/api/v1/keys/:id` ## Kelio parametrai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `id` | `integer` | taip | | Užklausos turinio nereikia. ## Atsakymas JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose. Atsakymo schema, reikšmės pavyzdinės ```json { "code": 0, "message": "success", "data": { "message": "VALUE_FROM_RESPONSE" } } ``` Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu. Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas. Ypatybės: atsakyme yra slaptas key; tikrų reikšmių neviešinkite. Metodas keičia duomenis. Pakartotinai siųsti saugu tik tada, kai prie metodo nurodytas Idempotency-Key. Jei atsakymas prarastas, pirmiausia patikrinkite rezultatą (pavyzdžiui, raktų sąrašą), tada spręskite, ar kartoti užklausą. **GET /api/v1/keys/:id** — Gavimas pagal identifikatorių — API raktai Prieiga: paskyros žetonas GET`/api/v1/keys/:id` Skaitymas; ID paimamas iš ankstesnio jūsų atsakymo ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys/$ID" \ -H "Authorization: Bearer $TOKEN" ``` ## Kelio parametrai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `id` | `integer` | taip | | Užklausos turinio nereikia. Aukščiau nurodytus parametrus perduokite URL. ## Atsakymas JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose. Atsakymo duomenų schemos: `APIKey`. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“. Atsakymo schema, reikšmės pavyzdinės ```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)" } } ``` Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu. Ypatybės: atsakyme yra slaptas key; tikrų reikšmių neviešinkite. **PUT /api/v1/keys/:id** — API rakto keitimas Prieiga: paskyros žetonas PUT`/api/v1/keys/:id` ## Kelio parametrai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `id` | `integer` | taip | | ## JSON / formos laukai | Laukas | Tipas | Privaloma | Patikra / aprašymas | | --- | --- | --- | --- | | `name` | `string` | ne | | | `status` | `string` | ne | omitempty,oneof=active inactive | | `ip_whitelist` | `array` | ne | ; Leidžiami IP: null nekeičia sąrašo, tuščias masyvas jį išvalo; gali būti null | | `ip_blacklist` | `array` | ne | ; Draudžiami IP: null nekeičia sąrašo, tuščias masyvas jį išvalo; gali būti null | | `quota` | `number` | ne | ; Rakto išlaidų limitas USD; 0 — be limito; gali būti null | | `expires_at` | `string` | ne | ; Galiojimo pabaigos laikas ISO 8601 formatu; gali būti null | | `reset_quota` | `boolean` | ne | ; Nustatyti išnaudotą išlaidų limito dalį į nulį; gali būti null | | `rate_limit_5h` | `number` | ne | ; gali būti null | | `rate_limit_1d` | `number` | ne | ; gali būti null | | `rate_limit_7d` | `number` | ne | ; gali būti null | | `reset_rate_limit_usage` | `boolean` | ne | ; Nustatyti išlaidų limitų per laiko langus naudojimą į nulį; gali būti null | Užklausos turinio šablonas ```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 žymi jūsų įvestį ir jos tipą. Pakeiskite reikšmes ir palikite tik reikalingus neprivalomus laukus; eilučių žymekliai nesiunčiami vietoj skaičių, boolean, objektų ar masyvų. Užklausos schema: `UpdateAPIKeyRequest` ## Atsakymas JSON atsakyme yra code, message ir data. data turinys aprašytas toliau pateiktose schemose. Atsakymo duomenų schemos: `APIKey`. Laukai ir tipai pateikti puslapiuose „Duomenų schemos“. Atsakymo schema, reikšmės pavyzdinės ```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)" } } ``` Ypatybės: visi asmens duomenys ir objektai apriboti JWT subjektu. Ypatybės: operacija keičia būseną arba tęsia vienkartinę autorizaciją; pavyzdys aprašo sutartį ir nėra vykdomas. Ypatybės: atsakyme yra slaptas key; tikrų reikšmių neviešinkite. Ypatybės: kol raktas turi nebaigtų užklausų su rezervu, negalima mažinti jo išlaidų limito ar atstatyti panaudotos limito dalies skaitiklio. Perduokite tik keičiamus laukus. Metodas keičia duomenis. Pakartotinai siųsti saugu tik tada, kai prie metodo nurodytas Idempotency-Key. Jei atsakymas prarastas, pirmiausia patikrinkite rezultatą (pavyzdžiui, raktų sąrašą), tada spręskite, ar kartoti užklausą. Liko klausimų? Atsiųskite Request ID ir aprašymą — padėsime išsiaiškinti.[Rašyti pagalbos tarnybai](mailto:support@ailoot.ai) ## Ailoot · Įmonė ir jos projektų portfelis Ailoot remiasi sukaupta veiklos patirtimi, plačia klientų baze, stabiliomis paslaugomis ir nuolatine KPI kontrole. Įmonė ir jos projektų portfelis: milijonai klientų; mėnesio pardavimai siekia milijardus. Ailoot šią veiklos patirtį pritaiko teikdama API prieigą prie DI funkcijų klientų produktuose, agentuose, programose ir automatizavimo sprendimuose.