Перейти к содержанию

REST-API


Публичный API GitFlic позволяет взаимодействовать с сервисом с помощью HTTP-запросов, для получения или изменения данных в соответствии с заданными параметрами запроса. Подобный вид взаимодействия обеспечивает пользователей новыми функциональными возможностями. Например, с помощью публичного API можно автоматизировать процессы, получать данные для аналитики или интегрировать сервис со сторонним приложением.

Создание REST-API запроса

Для того, чтобы создать REST-API запрос, необходимо обратиться на определенный адрес (endpoint), который должен иметь следующее начало:

Домен и порт при работе с self-hosted решением могут отличаться.

Полный адрес запроса зависит от конкретного метода, которым необходимо воспользоваться. Ознакомиться со всеми доступными методами можно здесь.

Пример запроса Пример запроса для получения списка публичных проектов на [gitflic.ru](https://gitflic.ru)
api.gitflic.ru/project

Авторизация в запросе

Отправка любого REST-API метода требует авторизации. Для этого необходимо создать токен доступа и указать его в заголовке запроса в следующей форме:

Authorization: token <access token>

<access token> - созданный токен доступа.

Ознакомиться с инструкцией по созданию токена доступа можно здесь.

При работе с API, владелец токена не должен быть заблокирован. У владельца не должно быть требования обновить пароль.

Ограничение на число запросов

При работе с API на gitflic.ru действует ограничение - максимально возможно отправить 500 запросов в час. Ограничение при работе с API в self-hosted сборках зависит от указанных настроек.

Формат ответа

После отправки запроса придет ответ в формате JSON. Некоторые запросы могут возвращать ответ в текстовом формате (plain text).

Каждый ответ содержит код ответа, который указывает на результат запроса и полезен при устранении неполадок. Список часто встречаемых кодов представлен ниже:

  • 200 OK - запрос успешно обработан. Как правило, тело ответа содержит запрошенные данные.
  • 400 Bad Request - запрос был сформирован с ошибками. Например, в нём присутствовали невалидные символы.
  • 403 Forbidden - запрос не был выполнен из-за проблем с авторизацией. Например, был использован токен доступа, не обладающий достаточным набором прав.
  • 404 Not Found - сервер не смог найти запрашиваемые данные. Например, запрос обращается к проекту, которого не существует.

Пагинация в запросах

Если запрос возвращает объект, содержащий в себе список каких-либо сущностей, то к такому запросу возможно применить пагинацию - указать количество сущностей на странице или перейти на определенную страницу. Ознакомиться с правилами работы с пагинацией можно здесь.


Описание доступных методов: