# Gauti API indeksą

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

Šaltinis: https://diko.app/api-docs/zinynas/get-api-index

Paskyra · `GET /`

- **Bazinis URL:** https://api.diko.app/api/v1
- **Reikalingas leidimas:** 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`

- `object` (string, privalomas): Visada `api`.
- `version` (string, privalomas): API versija, `v1`. Galimos reikšmės: `v1`.
- `docs_url` (string, privalomas, format: uri): Nuoroda į dokumentaciją.
- `openapi_url` (string, privalomas, format: uri): Nuoroda į OpenAPI 3.1 dokumentą.

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

## Pavyzdžiai

**cURL**

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

**Python**

```python
import requests

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

**TypeScript**

```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())
```

## Klaidos

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

| HTTP | Kodas | Reikšmė | Kartoti? |
|---|---|---|---|
| 404 | [`api_disabled`](https://diko.app/api-docs/klaidos.md#api_disabled) | Viešas API šiuo metu išjungtas. | sąlygiškai |
| 500 | [`internal_error`](https://diko.app/api-docs/klaidos.md#internal_error) | Vidinė serverio klaida. | sąlygiškai |