Документация по API

Главная
Документация по API

Синтаксис запроса

Чтобы обратиться к методу API, нужно выполнить GET-запрос вида:

GET https://mocraft.ru/api/v1/<METHOD>?<PARAMS> HTTP/1.1

Все методы API отвечают JSON-объектом

Path-параметры

GET https://mocraft.ru/api/v1/server.get?<PARAMS> HTTP/1.1

Важно. Имя метода чувствительно к регистру.

Query-параметры

PARAMS (необязательный) — входные параметры соответствующего метода API, последовательность пар name=value, разделённых амперсандом. Список параметров указан на странице с описанием метода

Пример

Вызовем метод server.get для сервера с идентификатором 7:

GET https://mocraft.ru/api/v1/server.get?id=7 HTTP/1.1

Пример ответа:

JSON

{
    "success":true,
    "data": {
        "id":7,
        "title":"BungeeCord 1.8.x-1.19.x",
        "ip":"hot.hyneo.ru",
        "rating":0,
        "ball":0,
        "players":15,
        "players_max":99,
        "status":0
    }
}

Запрос из PHP

PHP

<?php
    $serverId = 7;
    $requestParams = array(
        'id' => $serverId
    );
    $getParams = http_build_query($requestParams);
    $result = json_decode(file_get_contents('https://mocraft.ru/api/v1/server.get?' . $getParams));
    echo ($result->data->title);
?>