• Post category:Начало работы
  • Запись изменена:01.11.2022

API Р7 Community Server реализован как REST через HTTP с использованием GET/POST/PUT/DELETE. Все ресурсы, такие как сообщения или комментарии, имеют свои собственные URL-адреса и предназначены для изолированного управления.

Аутентификация

Аутентификация в Р7 Community Server API осуществляется через HTTP-аутентификацию, т. е. каждый запрос должен включать HTTP-заголовок Authorization. Информацию и примеры см. в разделе «Аутентификация».

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

Чтобы определить формат запроса и ответа, убедитесь, что для заголовков Content-Type и Accept установлено значение application/json. Можно вызвать любой метод API с указанием формата ответа (json или xml).

Пример:

api/2.0/people/@self может вызываться как api/2.0/people/@self.json — тогда формат возвращаемого медиа = JSON и api/2.0/people/@self.xml — тогда формат возвращенный носитель = XML.

По умолчанию для ответа используется формат XML, если формат не указан в запросе (например, api/2.0/people/@self вернет XML-медиа).

Ответы

Если запрос выполнен успешно, он вернет код состояния в диапазоне 200 и, если в запросе не был указан формат, ответ в формате XML. Обратите внимание, что, как правило, если запрос приводит к созданию новой записи (например, нового сообщения или комментария и т. д.), ответ будет использовать статус «201 Created». Любая другая успешная операция (например, успешный запрос, удаление или обновление) вернет код состояния 200.

В случае сбоя запроса будет возвращен код состояния, отличный от 200, возможно, с информацией об ошибке в формате XML в качестве содержимого ответа. Например, если запрошенная запись не может быть найдена, ответ HTTP может выглядеть примерно так:

HTTP/1.1 404 Not Found

Ограничение скорости

Вы можете выполнять до 500 запросов за 10-секундный период с одного и того же IP-адреса для одной и той же учетной записи. Если вы превысите данный лимит, то для последующих запросов будет получен ответ 503.

Соглашения используемые в данной документации

В документации используются следующие условные обозначения:

{текст}: укажите текст, который следует заменить вашими собственными данными (ID, поисковый запрос с т.д.)

Получить помощь

Если у вас есть какие-то вопросы насчет Р7 Community Server, для начала попробуйте найти их в секции FAQ (Часто задаваемые вопросы)

Вы можете запросить доработку или сообщить об ошибке, отправив письмо на портал технической поддержки.