Source: https://ailoot.ai/docs/hu/cabinet/keys/ Canonical: https://ailoot.ai/docs/hu/cabinet/keys/ Language: hu [Fiók-API](https://ailoot.ai/docs/hu/) # API-kulcsok [Markdown](https://ailoot.ai/docs/hu/cabinet/keys/index.md) Metódusok, kérésmezők és válaszok. Ebben a részben 5 metódus található. Nyissa meg a metódust a hozzáférési feltételek, a kérésmezők és a válasz megtekintéséhez. | Metódus és útvonal | Leírás | Hozzáférés | | --- | --- | --- | | `GET /api/v1/keys` | Lista — API-kulcsok | Fióktoken | | `POST /api/v1/keys` | API-kulcs létrehozása | Fióktoken | | `DELETE /api/v1/keys/:id` | Törlés — API-kulcsok | Fióktoken | | `GET /api/v1/keys/:id` | Lekérés azonosító alapján — API-kulcsok | Fióktoken | | `PUT /api/v1/keys/:id` | API-kulcs módosítása | Fióktoken | **GET /api/v1/keys** — Lista — API-kulcsok Hozzáférés: fióktoken GET`/api/v1/keys` Olvasás; az azonosító a korábbi válaszából származik ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys" \ -H "Authorization: Bearer $TOKEN" ``` ## Query-paraméterek | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `sort_by` | `string` | nem | ; alapértelmezés: created\_at | | `sort_order` | `string` | nem | ; alapértelmezés: desc | | `search` | `string` | nem | | | `status` | `string` | nem | | | `page` | `integer` | nem | ; alapértelmezés: 1; positive; page\_size/limit \<=1000 | | `page_size` | `integer` | nem | ; alapértelmezés: 20; positive; page\_size/limit \<=1000 | | `limit` | `integer` | nem | ; alapértelmezés: 20; positive; page\_size/limit \<=1000 | A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg. ## Válasz A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le. A válasz adatsémái: `APIKey`. A mezők és típusok az „Adatsémák” oldalain találhatók. Válaszséma, szemléltető értékekkel ```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)" } } ``` Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött. Sajátosságok: a válasz titkos key értéket tartalmaz; a valódi értékeket ne tegye közzé. **POST /api/v1/keys** — API-kulcs létrehozása Hozzáférés: fióktoken POST`/api/v1/keys` ## JSON- / űrlapmezők | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `name` | `string` | igen | required | | `custom_key` | `string` | nem | ; Nem kötelező, saját kulcsérték; null is lehet | | `ip_whitelist` | `array` | nem | ; Engedélyezett IP-címek listája | | `ip_blacklist` | `array` | nem | ; Tiltott IP-címek listája | | `quota` | `number` | nem | ; A kulcs költési korlátja USD-ben; null is lehet | | `expires_in_days` | `integer` | nem | ; Érvényesség napokban; null is lehet | | `rate_limit_5h` | `number` | nem | ; null is lehet | | `rate_limit_1d` | `number` | nem | ; null is lehet | | `rate_limit_7d` | `number` | nem | ; null is lehet | Kéréstörzs-sablon ```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)" } ``` A PLACEHOLDER az Ön által megadandó értéket és annak típusát jelöli. Cserélje ki az értékeket, és csak a szükséges nem kötelező mezőket tartsa meg; karakterlánc-jelölők nem küldhetők számok, boolean értékek, objektumok vagy tömbök helyett. A kérés sémája: `CreateAPIKeyRequest` ## Válasz A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le. A válasz adatsémái: `APIKey`. A mezők és típusok az „Adatsémák” oldalain találhatók. Válaszséma, szemléltető értékekkel ```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)" } } ``` Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött. Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra. Sajátosságok: az Idempotency-Key támogatott; ismétléskor a tárolt válasz érkezik az X-Idempotency-Replayed fejléccel. Sajátosságok: a válasz titkos key értéket tartalmaz; a valódi értékeket ne tegye közzé. A metódus adatokat módosít. Az újraküldés csak ott biztonságos, ahol a metódusnál szerepel az Idempotency-Key. Ha a válasz elveszett, előbb ellenőrizze az eredményt (például a kulcsok listáját), és csak utána döntsön az újbóli elküldésről. **DELETE /api/v1/keys/:id** — Törlés — API-kulcsok Hozzáférés: fióktoken DELETE`/api/v1/keys/:id` ## Útvonalparaméterek | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `id` | `integer` | igen | | A kéréshez nem szükséges törzs. ## Válasz A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le. Válaszséma, szemléltető értékekkel ```json { "code": 0, "message": "success", "data": { "message": "VALUE_FROM_RESPONSE" } } ``` Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött. Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra. Sajátosságok: a válasz titkos key értéket tartalmaz; a valódi értékeket ne tegye közzé. A metódus adatokat módosít. Az újraküldés csak ott biztonságos, ahol a metódusnál szerepel az Idempotency-Key. Ha a válasz elveszett, előbb ellenőrizze az eredményt (például a kulcsok listáját), és csak utána döntsön az újbóli elküldésről. **GET /api/v1/keys/:id** — Lekérés azonosító alapján — API-kulcsok Hozzáférés: fióktoken GET`/api/v1/keys/:id` Olvasás; az azonosító a korábbi válaszából származik ```bash curl --fail-with-body "https://ailoot.ai/api/v1/keys/$ID" \ -H "Authorization: Bearer $TOKEN" ``` ## Útvonalparaméterek | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `id` | `integer` | igen | | A kéréshez nem szükséges törzs. A fent felsorolt paramétereket az URL-ben adja meg. ## Válasz A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le. A válasz adatsémái: `APIKey`. A mezők és típusok az „Adatsémák” oldalain találhatók. Válaszséma, szemléltető értékekkel ```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)" } } ``` Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött. Sajátosságok: a válasz titkos key értéket tartalmaz; a valódi értékeket ne tegye közzé. **PUT /api/v1/keys/:id** — API-kulcs módosítása Hozzáférés: fióktoken PUT`/api/v1/keys/:id` ## Útvonalparaméterek | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `id` | `integer` | igen | | ## JSON- / űrlapmezők | Mező: | Típus | Kötelező | Ellenőrzés / leírás | | --- | --- | --- | --- | | `name` | `string` | nem | | | `status` | `string` | nem | omitempty,oneof=active inactive | | `ip_whitelist` | `array` | nem | ; Engedélyezett IP-címek: a null nem módosítja a listát, az üres tömb kiüríti; null is lehet | | `ip_blacklist` | `array` | nem | ; Tiltott IP-címek: a null nem módosítja a listát, az üres tömb kiüríti; null is lehet | | `quota` | `number` | nem | ; A kulcs költési korlátja USD-ben; 0 — korlátlan; null is lehet | | `expires_at` | `string` | nem | ; Lejárati idő ISO 8601 formátumban; null is lehet | | `reset_quota` | `boolean` | nem | ; A költési korlát felhasznált részének nullázása; null is lehet | | `rate_limit_5h` | `number` | nem | ; null is lehet | | `rate_limit_1d` | `number` | nem | ; null is lehet | | `rate_limit_7d` | `number` | nem | ; null is lehet | | `reset_rate_limit_usage` | `boolean` | nem | ; Az időablakos korlátok felhasználásának nullázása; null is lehet | Kéréstörzs-sablon ```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)" } ``` A PLACEHOLDER az Ön által megadandó értéket és annak típusát jelöli. Cserélje ki az értékeket, és csak a szükséges nem kötelező mezőket tartsa meg; karakterlánc-jelölők nem küldhetők számok, boolean értékek, objektumok vagy tömbök helyett. A kérés sémája: `UpdateAPIKeyRequest` ## Válasz A JSON-válasz code, message és data mezőt tartalmaz. A data tartalmát az alábbi sémák írják le. A válasz adatsémái: `APIKey`. A mezők és típusok az „Adatsémák” oldalain találhatók. Válaszséma, szemléltető értékekkel ```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)" } } ``` Sajátosságok: minden személyes adat és objektum a JWT alanyához kötött. Sajátosságok: a művelet állapotot módosít vagy egyszeri hitelesítést folytat; a példa a szerződést írja le, és nem kerül végrehajtásra. Sajátosságok: a válasz titkos key értéket tartalmaz; a valódi értékeket ne tegye közzé. Sajátosságok: amíg a kulcshoz befejezetlen, zárolással rendelkező kérések tartoznak, költési korlátja nem csökkenthető vagy nullázható. Csak a módosítandó mezőket adja meg. A metódus adatokat módosít. Az újraküldés csak ott biztonságos, ahol a metódusnál szerepel az Idempotency-Key. Ha a válasz elveszett, előbb ellenőrizze az eredményt (például a kulcsok listáját), és csak utána döntsön az újbóli elküldésről. Maradt kérdése? Küldje el a Request ID-t és a probléma leírását — segítünk tisztázni.[Írjon a támogatásnak](mailto:support@ailoot.ai) ## Ailoot · A vállalat és projektportfóliója Az Ailoot felhalmozott működési tapasztalatra, széles ügyfélkörre, stabil szolgáltatásra és folyamatos KPI-ellenőrzésre épít. A vállalat és projektportfóliója: ügyfelek milliói; havi értékesítés milliárdos nagyságrendben. Az Ailoot ezt a működési tapasztalatot használja az ügyfelek termékeiben, ágenseiben, alkalmazásaiban és automatizálásaiban elérhető AI-funkciók API-hozzáféréséhez.