Перейти к основному содержимому

API

Добро пожаловать в документацию API! Здесь вы найдёте информацию о том, как использовать наш API для интеграции.

Базовый URL​

Все запросы к API отправляются по следующему базовому URL: https://api.postmypost.io/v4/.

Авторизация​

Для использования API необходимо авторизоваться через Bearer токен. Все запросы API требуют добавление заголовка Authorization с вашим токеном: Authorization: Bearer <ваш_токен>

Пример запроса​

curl -X GET "https://api.postmypost.io/v4/endpoint" \
-H "Authorization: Bearer <ваш_токен>" \
-H "Content-Type: application/json"

Сортировка​

Для сортировки данных в запросах можно использовать параметр sort.

Основные принципы сортировки​

  • sort=name — сортировка по возрастанию значения поля name.
  • sort=-name — сортировка по убыванию значения поля name.

Для сортировки сразу по нескольким полям можно передать их через запятую.

Пример использования​

curl -X GET "https://api.postmypost.io/v4/endpoint?sort=-name,id,-date" \
-H "Authorization: Bearer <ваш_токен>" \
-H "Content-Type: application/json"

В данном примере

  • sort=-name — сортировка по полю name в порядке убывания.
  • sort=id — сортировка по полю id в порядке возрастания.
  • sort=-date — сортировка по полю date в порядке убывания.

Пагинация​

Для работы с большим объёмом данных рекомендуется использовать пагинацию. Она регулируется параметрами page и per-page.

  • page — номер страницы.
  • per-page — количество записей на одной странице (до 50 записей).

Пример использования​

curl -X GET "https://api.postmypost.io/v4/endpoint?page=2&per-page=50" \
-H "Authorization: Bearer <ваш_токен>" \
-H "Content-Type: application/json"

В данном примере

  • page=2 запрашивает вторую страницу данных.
  • per-page=50 ограничивает количество записей на странице до максимально допустимого значения — 50.

Примечание: Значение per-page не может превышать 50. Если указано больше, API автоматически ограничит количество записей до 50.

Информация о страницах​

API возвращает специальные заголовки в ответе для информирования о текущей странице и связанных параметрах пагинации.

  • X-Pagination-Total-Count — общее количество записей.
  • X-Pagination-Page-Count — общее количество страниц.
  • X-Pagination-Current-Page — номер текущей страницы.
  • X-Pagination-Per-Page — количество записей на текущей странице.

Часто задаваемые вопросы​

Где взять Bearer токен?​

Токены можно получить в панели пользователя в разделе «Токены доступа».