# API Authentication

Для взаимодействия с API используется стандартная токен-авторизация через API Key.

Все запросы должны отправляться в формате JSON (UTF-8) и содержать необходимые заголовки.

***

### Базовый адрес API

Если панель и API работают на поддомене app, точка входа выглядит так:

```
https://app.{ваш_домен}/api/v3
```

{% hint style="info" %}

## Примеры подстановки: 

Если ваш домен: **iexexchanger.com**

Базовый URL API: <https://app.**iexexchanger.com**/api/v3>
{% endhint %}

***

### Структура маршрутов

Публичные методы (без авторизации):

```
https://app.{ваш_домен}/api/v3/public/*
```

Пример:

```
https://app.{ваш_домен}/api/v3/public/rates.xml
```

Приватные методы (требуется токен):

```
https://app.{ваш_домен}/api/v3/private/*
```

Примеры:

```
https://app.{ваш_домен}/api/v3/private/health
https://app.{ваш_домен}/api/v3/private/account
```

***

### Обязательные заголовки

Каждый запрос к приватному API должен содержать:

```
Accept: application/json
Content-Type: application/json; charset=utf-8
Authorization: Bearer YOUR_API_KEY
```

Где **`YOUR_API_KEY`** — API-ключ из личного кабинета пользователя.

***

### Пример на Laravel HTTP Client (с учётом app-домена)

```php
use Illuminate\Support\Facades\Http;

$apiKey  = 'YOUR_API_KEY'; // ваш API-ключ
$baseUrl = 'https://app.{ваш_домен}/api/v3/private';

$client = Http::baseUrl($baseUrl)
    ->withToken($apiKey)   // Authorization: Bearer {token}
    ->acceptJson()         // Accept: application/json
    ->asJson();            // Content-Type: application/json
```

Тест авторизации:  `/health`

```php
$response = $client->get('health');

if ($response->successful()) {
    dd('API OK', $response->json());
} else {
    dd('API ERROR', $response->status(), $response->body());
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.iexexchanger.com/front-api/osnovnoe/api-authentication.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.