Состояние приложения

Метод предназначен для получение текущего состояния API

Эндпоинт health предназначен для быстрой проверки работы API, корректности авторизации и текущих прав (abilities) токена.

• Метод: GET

• Путь: https://app.{ваш_домен}/api/v3/private/health

Замените {ваш_домен} на домен вашей панели/обменника.

Например:

https://app.iexexchanger.com/api/v3/private/health

---

Пример запроса (cURL)

curl -X GET "https://app.{ваш_домен}/api/v3/private/health" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Authorization: Bearer YOUR_API_KEY"

Пример запроса (Laravel HTTP Client)

use Illuminate\Support\Facades\Http;

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

$client = Http::baseUrl($baseUrl)
    ->withToken($apiKey)   // добавляет заголовок Authorization: Bearer {token}
    ->acceptJson()
    ->asJson();

// Тест состояния API и авторизации
$response = $client->get('health');

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

---

Структура ответа

{
  "type": "health",
  "attributes": {
    "status": "ok",
    "authenticated": true,
    "user": {
      "id": 1,
      "name": "Demo User",
      "email": "[email protected]"
    },
    "abilities": [
      "account",
      "partner"
    ]
  },
  "meta": {
    "timestamp": "2025-12-06T15:30:12+00:00",
    "app": "iEXExchanger",
    "version": "10.3.0"
  }
}