Gauti dabartinį raktą ir paskyrą

Atverti Markdown

Grąžina užklausai naudotą raktą, už jo esančią paskyrą, ar paskyra gali naudoti API, kreditų likutį, ribas ir tai, kaip užklausa buvo matoma.

GET/me

Reikalingas leidimas: Bet kuris galiojantis raktas
Autentifikacija: Authorization: Bearer
Ribų politika: readaccountme

Veikia su bet kuriuo galiojančiu raktu, net jei planas neapima API, todėl tai tinkamiausia užklausa prieigos problemoms diagnozuoti. Paskyros el. paštas visada paslepiamas, o kreditų likutis grąžinamas tik tada, kai raktas turi leidimą library:write (kitu atveju jis yra null). Turi savo ribą: viena užklausa per sekundę (pradinė talpa, angl. burst, – penkios užklausos).

Atsakymas

200

Raktas, paskyra ir jos ribos.

RateLimit Labiausiai ribojanti taikyta politika: "pavadinimas";r=<liko užklausų>;t=<sekundės>. t – sekundės iki kitos leidžiamos užklausos (0, kai talpa pilna). Nesiunčiama, kai užklausai ribotuvas netaikytas.
RateLimit-Policy Užklausai taikytos ribų politikos, po vieną elementą "pavadinimas";q=<pradinė talpa>;w=<sekundės> kiekvienai, pavyzdžiui, "read";q=10;w=2, "account";q=20;w=2: q – pradinė talpa, w – sekundės, per kurias tuščia talpa vėl prisipildo. Siunčiama su kiekvienu autentifikuotu atsakymu; nesiunčiama, kai užklausai ribotuvas netaikytas, pavyzdžiui, kai ji atmesta dar nepatikrinus rakto.
Request-Id Šios užklausos ID (priešdėlis req_), toks pat kaip request_id klaidos atsakyme. Siunčiamas ir kaip X-Request-ID. Kreipdamiesi pagalbos nurodykite jį.
X-Client-Request-Id Jūsų siųsta užklausos antraštė X-Client-Request-Id, grąžinta atgal. Grąžinama tik tada, kai jūsų reikšmė turi 1–128 simbolius iš A-Z a-z 0-9 . _ : -.
X-RateLimit-Limit Labiausiai ribojančios politikos pradinė talpa (q antraštėje RateLimit-Policy). Nesiunčiama, kai užklausai ribotuvas netaikytas.
X-RateLimit-Remaining Labiausiai ribojančioje politikoje likusios užklausos (r antraštėje RateLimit). Nesiunčiama, kai užklausai ribotuvas netaikytas.
X-RateLimit-Reset Sekundės iki kitos leidžiamos užklausos labiausiai ribojančioje politikoje (t antraštėje RateLimit; 0, kai talpa pilna). Tai sekundžių skaičius, o ne laiko žyma. Nesiunčiama, kai užklausai ribotuvas netaikytas.

Turinio tipas: application/json

objectstringprivalomas
Visada me.
api_keyobjectprivalomas
Šiai užklausai naudotas raktas.
18 laukų
- idstringprivalomas
  Viešas rakto ID (priešdėlis key_).
  26–26 simbolių · pattern: ^key_[0-9A-Za-z]{22}$
- objectstringprivalomas
  Visada api_key.
- namestringprivalomas
  Raktui suteiktas pavadinimas.
- descriptionstringprivalomas
  Neprivalomas aprašas; tuščia eilutė, kai nenustatytas.
- hintstringprivalomas
  Neslapta užuomina: priešdėlis ir pirmi bei paskutiniai keturi atsitiktinės dalies simboliai.
- scopesarray<string>privalomas
  Raktui suteikti leidimai.
  Galimos reikšmės: meetings:readlibrary:readlibrary:write
- statusstringprivalomas
  Gyvavimo ciklo būsena. expired išvedama iš expires_at.
  Galimos reikšmės: activedisabledrevokedexpired
- allowed_cidrsarray<string>privalomas
  IP sąrašas CIDR forma. Tuščias sąrašas leidžia bet kurį adresą.
- created_atstringprivalomas
  Kada raktas sukurtas.
  ≤ 24 simbolių · format: date-time
- expires_atstringprivalomas
  Kada raktas nustoja veikti. Kiekvienas raktas turi galiojimą; daugiausia 365 dienos.
  ≤ 24 simbolių · format: date-time
- last_used_atstring | nullprivalomas
  Paskutinis panaudojimas, rašomas ne dažniau kaip kas 5 min. null, jei niekada nenaudotas.
  ≤ 24 simbolių · format: date-time
- last_used_ipstring | nullprivalomas
  Paskutinio panaudojimo IP. Saugomas tik tada, kai adresą pavyko nustatyti patikimai.
- first_used_atstring | nullprivalomas
  Pirmas panaudojimas. null, jei niekada nenaudotas.
  ≤ 24 simbolių · format: date-time
- disabled_atstring | nullprivalomas
  Kada raktas išjungtas, jei jis išjungtas.
  ≤ 24 simbolių · format: date-time
- revoked_atstring | nullprivalomas
  Kada raktas atšauktas, jei jis atšauktas.
  ≤ 24 simbolių · format: date-time
- revoked_reasonstring | nullprivalomas
  Kodėl raktas atšauktas: user (atšaukėte jūs), rotated (pasibaigė rotacijos persidengimas), admin (atšaukė komandos administratorius), owner (atšaukė komandos savininkas), user_disabled (paskyra išjungta), leaked (aptiktas nutekėjimas), dormant (nenaudotas metus), revoke_all (veiksmas „Atšaukti visus“).
  Galimos reikšmės: userrotatedadminowneruser_disabledleakeddormantrevoke_all
- rotated_fromstring | nullprivalomas
  Rakto, kurį šis raktas pakeitė rotacijos metu, ID.
  26–26 simbolių · pattern: ^key_[0-9A-Za-z]{22}$
- grace_untilstring | nullprivalomas
  Iki kada ankstesnis raktas veikia po rotacijos.
  ≤ 24 simbolių · format: date-time
userobjectprivalomas
Raktą valdanti paskyra.
4 laukai
- idstringprivalomas
  Viešas naudotojo ID (priešdėlis usr_).
  26–26 simbolių · pattern: ^usr_[0-9A-Za-z]{22}$
- objectstringprivalomas
  Visada user.
- emailstringprivalomas
  Paskyros el. pašto adresas, paslėptas (pavyzdžiui, j***@example.com). Pilnas adresas API raktui niekada negrąžinamas.
- display_namestring | nullprivalomas
  Rodomas vardas, jei nustatytas.
accessobjectprivalomas
Ar paskyra gali naudoti API.
3 laukai
- allowedbooleanprivalomas
  true, kai API užklausos leidžiamos. GET /me veikia ir tada, kai reikšmė false.
- reasonstringprivalomas
  Kodėl prieiga suteikta arba nesuteikta.
  Galimos reikšmės: subscriptionteamownerexemptpaywall_offsubscription_requiredplan_required
- planstring | nullprivalomas
  Paskyros plano tipas arba null.
  Galimos reikšmės: asmeninisproverslas
creditsobject | nullprivalomas
Kreditų likutis. null, nebent raktas turi leidimą library:write – vienintelį, kuris naudoja kreditus.
3 laukai
- scopestring | nullprivalomas
  Kieno tai likutis: asmeninis ar bendras komandos kreditų fondas. null, kai nepavyko nuskaityti.
  Galimos reikšmės: userorganization
- availablestring | nullprivalomas
  Turimi kreditai dešimtaine eilute, pavyzdžiui, "123.5000". null, kai nepavyko nuskaityti.
- as_ofstring | nullprivalomas
  Kada likutis nuskaitytas. Jis talpinamas 30 s kiekvienam naudotojui. null, kai nepavyko nuskaityti.
  ≤ 24 simbolių · format: date-time
limitsobjectprivalomas
Taikomos ribos.
3 laukai
- rateobjectprivalomas
  Ribų politikos.
  6 laukai
  - readobjectprivalomas
    Politika read, vienam API raktui.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
  - writeobjectprivalomas
    Politika write, vienam API raktui.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
  - importsobjectprivalomas
    Politika imports, vienam API raktui.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
  - accountobjectprivalomas
    Politika account, bendra visiems mokėtojo raktams ir nariams: komandos plane – mokančiai komandai, kitu atveju – naudotojui.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
  - meobjectprivalomas
    Politika me, vienam API raktui; taikoma tik GET /me.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
  - exportobjectprivalomas
    Politika export, bendra visiems mokėtojo raktams ir nariams (komandos plane – mokančiai komandai, kitu atveju – naudotojui); taikoma transkriptams su format=text, srt ar vtt.
    3 laukai
    burstintegerprivalomas
    Pradinė talpa (burst): kiek užklausų galima išsiųsti iš karto.
    0–2147483647 · format: int32
    per_secondinteger | null
    Papildymas žetonais per sekundę, kai politika pildoma per sekundę.
    0–2147483647 · format: int32
    per_minuteinteger | null
    Papildymas žetonais per minutę, kai politika pildoma per minutę.
    0–2147483647 · format: int32
- max_active_importsintegerprivalomas
  Daugiausia vienu metu aktyvių naudotojo importų.
  0–2147483647 · format: int32
- max_daily_importsintegerprivalomas
  Daugiausia importų, kuriuos naudotojas gali sukurti per parą.
  0–2147483647 · format: int32
requestobjectprivalomas
Kaip ši užklausa buvo matoma.
2 laukai
- ipstring | nullprivalomas
  Kliento IP, kaip jį mato Diko, arba null, kai patikimai nustatyti nepavyksta.
- ip_trustedbooleanprivalomas
  Ar IP gautas iš patikimos tarpinių serverių grandinės. IP sąrašams reikia patikimo IP.

Pavyzdžiai

Užklausa

cURL

curl "https://api.diko.app/api/v1/me" \
  -H "Authorization: Bearer $DIKO_API_KEY"

Python

import os

import requests

response = requests.get(
    "https://api.diko.app/api/v1/me",
    headers={"Authorization": f"Bearer {os.environ['DIKO_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

TypeScript

const response = await fetch("https://api.diko.app/api/v1/me", {
  headers: {
    Authorization: `Bearer ${process.env.DIKO_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`)
console.log(await response.json())

Atsakymo pavyzdys · 200 · application/json

JSON

{
  "object": "me",
  "api_key": {
    "id": "key_4Vf9771zpS8JcQdtUcR0u8",
    "object": "api_key",
    "name": "CRM sync",
    "description": "",
    "hint": "dk_live_Ab12…9xYz",
    "scopes": [
      "meetings:read",
      "library:write"
    ],
    "status": "active",
    "allowed_cidrs": [],
    "created_at": "2026-10-11T09:00:00.000Z",
    "expires_at": "2027-01-09T09:00:00.000Z",
    "last_used_at": null,
    "last_used_ip": null,
    "first_used_at": null,
    "disabled_at": null,
    "revoked_at": null,
    "revoked_reason": null,
    "rotated_from": null,
    "grace_until": null
  },
  "user": {
    "id": "usr_4iAD1dYhdAEJIkMN5GPczR",
    "object": "user",
    "email": "j***@example.com",
    "display_name": "Jonas"
  },
  "access": {
    "allowed": true,
    "reason": "subscription",
    "plan": "pro"
  },
  "credits": {
    "scope": "user",
    "available": "123.5000",
    "as_of": "2026-10-11T09:30:00.000Z"
  },
  "limits": {
    "rate": {
      "read": {
        "burst": 10,
        "per_second": 5
      },
      "write": {
        "burst": 5,
        "per_second": 1
      },
      "imports": {
        "burst": 5,
        "per_minute": 30
      },
      "account": {
        "burst": 20,
        "per_second": 10
      },
      "me": {
        "burst": 5,
        "per_second": 1
      },
      "export": {
        "burst": 10,
        "per_second": 1
      }
    },
    "max_active_imports": 10,
    "max_daily_imports": 500
  },
  "request": {
    "ip": null,
    "ip_trusted": false
  }
}

Klaidos

Šis endpointas gali grąžinti šias klaidas. Visų kodų aprašai yra klaidų kataloge.

HTTP	Kodas	Reikšmė	Kartoti?
401	`missing_api_key`	Užklausoje nėra antraštės `Authorization`.	ne
401	`invalid_api_key`	Antraštė netinkama (ne `Bearer` schema, tuščias raktas arba kelios antraštės `Authorization`) arba raktas nežinomas ar blogo formato (neatitinka struktūros ar kontrolinės sumos). Atsakymas visais šiais atvejais vienodas.	ne
401	`api_key_expired`	Rakto galiojimas pasibaigė.	ne
401	`api_key_revoked`	Raktas atšauktas: rankiniu būdu, pasibaigus rotacijos persidengimui, dėl nutekėjimo arba išjungus paskyrą.	ne
401	`api_key_disabled`	Raktas laikinai išjungtas.	ne
403	`ip_not_allowed`	Raktas turi IP apribojimą, o užklausos IP nėra sąraše arba jo nepavyksta nustatyti patikimai.	ne
403	`account_disabled`	Paskyra išjungta.	ne
403	`email_not_verified`	Paskyros el. paštas nepatvirtintas.	ne
403	`api_access_suspended`	Diko administratorius sustabdė šios paskyros API prieigą.	ne
429	`rate_limit_exceeded`	Viršyta ribų politika. `error.details.policy` nurodo, kuri.	taip, po Retry-After
500	`internal_error`	Vidinė serverio klaida.	sąlygiškai
503	`service_unavailable`	Paslauga laikinai užimta, pavyzdžiui, dėl duomenų bazės apkrovos.	taip, po Retry-After