---
title: 'Діагностика API'
description: Службова перевірка обміну даними між AI Analytics і платформою приладів обліку, що прозондовує кожен запит, на який спираються інші звіти.
section: AI Analytics
weight: 9
---

import Alert from '@/components/docs/Alert.astro';

Службова перевірка обміну даними між AI Analytics і платформою приладів обліку. Звіт по черзі звертається до всіх запитів платформи, якими користуються інші звіти, і показує, які з них відповідають нормально, а які повертають помилку. Адресат — адміністратор і технічна підтримка: запустіть його при підозрі на збій інтеграції й одразу побачте, де розірваний зв'язок з приладом або сервером.

<Alert type="info">
  Це службовий інструмент для адміністратора. Він доступний за прямим посиланням, а не із загального
  списку звітів, що показується операторам.
</Alert>

## Що показує

За кожним видом запиту платформи — рядок із результатом: яку адресу викликали, чи успішно відповів сервер, скільки рядків даних повернув і які поля були в першому рядку (щоб переконатися, що формат даних не змінився).

| Елемент рядка    | Що означає                                                                                                                 |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Адреса запиту    | який саме вид даних перевіряли (вхід у систему, список парку, довідники, сеанси зв'язку, архіви показань, паспорт приладу) |
| Стан             | чи відповів сервер успішно, чи повернув помилку                                                                            |
| Кількість рядків | скільки записів прийшло у відповіді                                                                                        |
| Приклади полів   | імена полів з першого запису — ознака, що формат не змінився                                                               |

Колір рядка задає код відповіді сервера:

| Колір                                                   | Що означає                                 |
| ------------------------------------------------------- | ------------------------------------------ |
| Зелений («200»)                                         | запит працює нормально                     |
| Жовтий (помилка прав, крім «не знайдено»)               | потрібно перевірити права доступу          |
| Червоний (серверна помилка або немає вчасної відповіді) | проблема на стороні сервера                |
| Сірий («404» — не знайдено)                             | такого запиту немає в цій версії платформи |

<Alert type="note">
  Адреси на кшталт `/api/v1/stations` та імена полів на кшталт `archive_type` — це технічні
  ідентифікатори запитів і полів платформи, а не налаштування для оператора.
</Alert>

## Як рахується

Звіт по черзі звертається до всіх запитів платформи, якими користуються інші звіти: вхід у систему, список парку, довідники (типи приладів, ресурсопостачальні організації, клієнти), сеанси зв'язку (у чотирьох варіантах параметрів), архіви показань (годинний, добовий, місячний, налаштування), архіви позаштатних ситуацій і журнали подій, а також паспорт приладу. Для кожного виклику фіксується адреса, відповідь сервера, кількість рядків та приклад полів. Якщо вказано конкретний вузол, додатково перевіряються архіви позаштатних ситуацій саме за ним.

## Параметри запуску

| Параметр                                                            | За замовчуванням     | Що означає                                                                                        |
| ------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------- |
| ID вузла для перевірки архівів позаштатних ситуацій (необов'язково) | береться з контексту | якщо заданий — перевірка йде за цим вузлом; якщо порожньо — береться перший вузол зі списку парку |

## Як читати результат

Дивіться на колір рядків. Суцільно зелені — обмін даними справний. Жовті рядки означають, що сервер на місці, але не віддає дані без потрібних прав — це привід перевірити доступ. Червоні рядки — збій на стороні сервера, їх розбирають першочергово. Сірі рядки («не знайдено») часто нормальні: не всі прилади підтримують усі види архівів, тож відсутність позаштатних архівів у конкретного приладу не є помилкою.

Урахуйте особливість входу в систему: платформа близько двох тижнів повторно використовує раніше отриману перепустку, тому перевірка входу зазвичай успішна і без реального повторного входу на сервер.

## Пов'язані звіти

Цей звіт самодостатній і ні від чого не залежить. Усі інші звіти парку користуються тими самими запитами платформи, що він перевіряє, — тому при їх збої починати діагностику варто звідси.