`service.ping` — Перевірка доступності

  1. Головна
  2. Сервісні методи
  3. `service.ping` — Перевірка доступності

service.ping — Перевірка доступності

Призначення

Швидка перевірка, що API доступне і може виконати простий запит до БД.

HTTP

  • URL: https://api13.arm20.com/ (ваш домен)
  • Метод: POST
  • Content-Type: application/json

Авторизація

  • Потрібні логін/пароль (як в онлайн статистиці): так.
  • meta.user_card: не обов’язково (це єдиний метод, де картку можна не передавати).

Параметри params

Цей метод не має параметрів. Передавайте params: {}.

Приклад запиту

Мокап: mockups/service/service.ping/request.json

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "service.ping",
  "params": {},
  "id": "example-service.ping"
}

Приклад відповіді (успіх)

Мокап: mockups/service/service.ping/response.ok.json

{
  "ok": true,
  "result": {
    "db": true,
    "time": "2026-01-26T12:00:00+00:00"
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "ping-001"
}

Примітки

  • Не потребує meta.user_card, щоб можна було перевірити доступність навіть до налаштування локальних користувачів.

Типові помилки

  • AUTH_REQUIRED / AUTH_FAILED — проблеми з логіном/паролем.

На цій сторінці