# API Индекса ATI.SU по направлениям

API предоставляет значение Индекса ATI.SU для 100 самых популярных направлений в РФ, входящих [в общий Индекс ATU.SU](https://ati.su/developers/raw/api/index_ati.md).

API позволяет запросить значения Индекса ATI.SU:

- по 100 самым популярным направлениям в РФ;
- для полностью загруженного транспорта 20 т, 82 м3;
- за интересующий вас период;
- для всех типов кузовов или отдельно для рефрижератора, открытого и закрытого кузова.

## Как получить доступ к API

Чтобы получить доступ к API – подключите лицензию «API Средних ставок» [на странице оплаты](https://billing.ati.su/addinvoice?option=2&services=569&priceperiod=1).

Если у вас остались вопросы — напишите в техническую поддержку на [api@ati.su](mailto:api@ati.su).

## Методы

### Динамика индекса по направлению

<a id="post-license-v1-index_by_direction"></a>

Динамика индекса по направлению

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/index/license/v1/index_by_direction' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "DateFrom": "2022-02-01",
  "DateTo": "2022-03-02",
  "From": {
    "Id": 0
  },
  "To": {
    "Id": 0
  },
  "CarType": "ref"
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/paid-api/index-by-directions.openapi.json)

**Описание полей запроса**
- `DateFrom` — Начало периода. Формат ISO-8601.
- `DateTo` — Конец периода. Формат ISO-8601.
- `From` — Точка откуда.
- `From.Id` — Id точки.
- `To` — Точка куда.
- `To.Id` — Id точки.
- `CarType` — Тип кузова. * `ref` – Рефрижераторы * `close` – Закрытые * `open` – Открытые * `all` – Все типы

**Пример ответа (200)**

```json
{
  "Data": [
    {
      "Date": "1970-01-01",
      "Index": 0
    }
  ]
}
```

**Описание полей ответа**
- `Data` — Набор данных индекса
- `Data[].Date` — Дата. Формат ISO-8601
- `Data[].Index` — Значение индекса

**Пример ответа (404)**

```json
{
  "error_body": "string",
  "reason": "string",
  "status_code": 0,
  "details": {}
}
```

**Описание полей ответа**
- `error_body` — основное тело ошибки с описанием
- `reason` — тип ошибки если имеется
- `status_code` — код возвращаемой ошибки
- `details` — какие-либо дополнительные детали ошибки


### Доступные направления индекса

<a id="get-license-v1-directions"></a>

Доступные направления индекса

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/index/license/v1/directions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/paid-api/index-by-directions.openapi.json)

**Пример ответа (200)**

```json
{
  "Directions": [
    {
      "From": {
        "Id": 0,
        "Name": "string"
      },
      "To": {
        "Id": 0,
        "Name": "string"
      }
    }
  ]
}
```

**Описание полей ответа**
- `Directions` — Все направления для индекса
- `Directions[].From` — Точка откуда.
- `Directions[].From.Id` — Id точки.
- `Directions[].From.Name` — Название точки.
- `Directions[].To` — Точка куда.
- `Directions[].To.Id` — Id точки.
- `Directions[].To.Name` — Название точки.