(itzrest) Rest API with authentication 4.0.16

Реализованные конечные точки

В настоящее время реализованы следующие конечные точки (больше будет доступно в будущем). И снова: на данный момент можно читать только данные. Вы должны префикс каждой конечной точки с помощью / restapi ".

Форумы

Вход как пользователь

Чтобы войти в систему как пользователь, вы должны отправить запрос POST в конечную точку /auth/login с вашим именем пользователя и паролем:

curl \
    -d username=max\
    -d password=secret\
    -X POST <baseurl>/restapi/auth/login

В результате вы получите объект с несколькими пользовательскими данными и самое главное: токен доступа:

{
    "data": {
        "id": "1",
        "name": "max",
        "access_token": "********",
        "photoUrl": "",
        "birthday": ""
    }
}

Сохраните секретный токен и используйте его для авторизированных вызовов API, как описано в шаге «Выполнять авторизированные запросы». Если вы используете аутентификацию, это будет лучший способ, если вы используете безопасное соединение (https) для совершения вызовов API.

Делать запросы

Не более, чем отправка запроса GET на конкретную конечную точку:

curl <baseurl>/restapi/<endpoint>

Например: Если вы хотите иметь все доступные календари:

curl POST <baseurl>/restapi/calendars

Ваш результат будет примерно таким:

{
    "data": [
        {
            "id": "1",
            "title": "Community Calendar",
            "title_seo": "community-calendar",
            "color": "#6E4F99"
        }
    ]
}

Выполнять авторизированные запросы

Для авторизированных запросов вам нужен токен доступа. Добавить маркер доступа в качестве заголовка авторизации и сделать запрос:

curl \
    -H "Authorization: Bearer <token>" \
    -X <baseurl>/restapi/forums

Вы можете проверить, действителен ли ваш токен, отправив запрос в конечную точку /auth/authenticate:

curl \
    -H "Authorization: Bearer <token>" \
    -X POST <baseurl>/restapi/auth/authenticate

В результате вы должны получить действительный объект пользователя.

Пагинация, заказ

Если у вашей доски есть thounsands сообщений или потоков, мы должны разбить результаты. В противном случае выполнение ваших запросов будет ужасным. Каждая конечная точка принимает параметры запроса для сортировки и разбиения на страницы ваших результатов простым способом. Поэтому каждая конечная точка имеет в своем мета-узле результат, который дает вам информацию о вашем текущем состоянии агитации:

"meta": {
    "pagination": {
        "total": "22",
        "count": "22",
        "per_page": "25",
        "current_page": "1",
        "total_pages": "1",
        "links": []
    }
}

Теперь давайте фильтровать/разбиение на страницы и ограничить ваши результаты:

curl <baseurl>/restapi/forums/2/topics?order=title&orderDirection=asc&limit=5&page=2

Мы получим следующий метавыход:

"meta": {
    "pagination": {
        "total": "22",
        "count": "5",
        "per_page": "5",
        "current_page": "2",
        "total_pages": "5",
        "links": {
            "previous": "<baseurl>/restapi/forums/2/topics/?page=1&order=title&orderDirection=asc&limit=5",
            "next": "<baseurl>/restapi/forums/2/topics/?page=3&order=title&orderDirection=asc&limit=5"
        }
    }
}