Gauti API indeksą

Atverti Markdown

Grąžina API pavadinimą, versiją ir nuorodas į dokumentaciją bei OpenAPI dokumentą.

GET/

Reikalingas leidimas: Autentifikacija nereikalinga
Autentifikacija: Autentifikacija nereikalinga

API rakto nereikia. Užklausai ribos netaikomos, todėl atsakyme nėra ribų antraščių.

Atsakymas

200

API indeksas.

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 . _ : -.

Turinio tipas: application/json

objectstringprivalomas
Visada api.
versionstringprivalomas
API versija, v1.
Galimos reikšmės: v1
docs_urlstringprivalomas
Nuoroda į dokumentaciją.
format: uri
openapi_urlstringprivalomas
Nuoroda į OpenAPI 3.1 dokumentą.
format: uri

Pavyzdžiai

Užklausa

cURL

curl "https://api.diko.app/api/v1"

Python

import requests

response = requests.get(
    "https://api.diko.app/api/v1",
    timeout=30,
)
response.raise_for_status()
print(response.json())

TypeScript

const response = await fetch("https://api.diko.app/api/v1")
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`)
console.log(await response.json())

Atsakymo pavyzdys · 200 · application/json

JSON

{
  "object": "api",
  "version": "v1",
  "docs_url": "https://diko.app/en/api-docs",
  "openapi_url": "https://api.diko.app/api/v1/openapi.json"
}

Klaidos

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

HTTP	Kodas	Reikšmė	Kartoti?
404	`api_disabled`	Viešas API šiuo metu išjungtas.	sąlygiškai
500	`internal_error`	Vidinė serverio klaida.	sąlygiškai