Перший запит: `service.ping`

  1. Головна
  2. Швидкий старт
  3. Перший запит: `service.ping`

Перший запит: service.ping

service.ping потрібен для швидкої перевірки:

  • чи доступний endpoint
  • чи є з’єднання з базою клієнта (після авторизації)

1) Варіант з авторизацією в JSON

Запит (JSON)

Файл мокапу: mockups/service/service.ping/request.json

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

Запит (curl)

curl -X POST https://api13.arm20.com/ \
  -H "Content-Type: application/json" \
  -d '{"auth":{"login":"<LOGIN>","password":"<PASSWORD>"},"method":"service.ping","params":{},"id":"ping-001"}'

Успішна відповідь

Файл мокапу: 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"
}

2) Варіант з Basic Auth

Якщо Basic Auth не “доїжджає” до PHP (часто nginx+php-fpm), використовуйте авторизацію в JSON.

Запит (curl)

curl -u "<LOGIN>:<PASSWORD>" \
  -X POST https://api13.arm20.com/ \
  -H "Content-Type: application/json" \
  -d '{"method":"service.ping","params":{},"id":"ping-001"}'

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