Получение и отправка данных происходит через вызов методов сервера, посредством http запросов, в то время как сами методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление.

Все методы разделены на секции(модули). Например, для авторизации и работы с токенами Вам нужны методы секции Auth, для работы со списком учеников - Students, и так далее. Полный список секций доступен на этой странице, в панели навигации, а на странице каждой секции приведён список доступных в ней методов.

В целях ускорения работы и сокращения количества запросов, один http запрос может содержать данные для последовательного вызова нескольких методов. Это достигается через передачу, в теле запроса, массива json-объектов, в каждом из которых должны быть указаны: идентификатор метода и передаваемые параметры. В ответе на http запрос сервер поместит результаты всех вызванных методов в том же порядке, в котором они были указаны в теле запроса.

Структура запроса

В тело POST http запроса нужно поместить json-массив json-объектов, артибутами которых указать идентификаторы методов и передаваемые параметры.

Идентификатор метода имеет вид "названиеCекции/названиеМетода" (регистр символов не имеет значения). Например, для вызова метода авторизации Login, который находится в секции Auth, идентификатором будет строка:

Чтобы вызвать метод авторизации, нужно сформировать пакет следующим образом:

[
    {
        "method" : "auth/login",
        "data" : {
            "phone": "***",
            "password" : "***"
        }
    }
]

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

В ответе сервер вернёт, аналогично запросу, json-массов json-объектов, в котором, по каждому запрошенному методу будут перечислены:

Пример запроса и ответа на вызов метода getParamsCount из секции lessonsMarksList:

[
    {
        "method" : "lessonsMarksList/GetParamsCount"
    }
]

[
    {
        "method": "lessonsMarksList/GetParamsCount",
        "resultStatus": 1,
        "result": {
            "count": "4"
        }
    }
]

Выполнение методов

Все http запросы выполняются методом POST, по адресу точки входа API. В теле запроса нужно поместить json-массива json-объектов, описывающих путь к методу и передаваемые параметры.

Существуют методы, не требующие авторизации. Их можно вызывать напрямую из точки входа. Для методов, требующих авторизации, нужно получить token авторизации, с помощью метода Login, секции Auth, а затем передать его GET параметром token, при обращении к точке входа API, например:

В случае, если GET параметр для token использовать не очень удобно или просто не хочется, параметр token можно разместить прямо в теле первого метода запроса, например:

[
    {
        "token" : "d765387407957642b2314c026789fac99b45cde5f84392e674",
        "method" : "lessonsMarksList/GetParamsCount"
    }
]