curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/profile-posts/123/?with_comments=1&page=1'
{
"profile_post": {
"profile_post_id": 123
},
"comments": [
{
"profile_post_comment_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Записи профиля
Получить запись профиля
Возвращает запись профиля с необязательной страницей комментариев.
GET
/
api
/
profile-posts
/
{id}
/
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/profile-posts/123/?with_comments=1&page=1'
{
"profile_post": {
"profile_post_id": 123
},
"comments": [
{
"profile_post_comment_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Возвращает запись профиля с необязательной страницей комментариев.
Обязательные scopes:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
profile_post:read.
Параметры
integer
required
ID записи профиля. Значение
123 в примере условное.boolean
При
1 добавляет страницу комментариев к записи профиля.integer
Номер страницы комментариев при
with_comments=1.string
Порядок комментариев:
desc — сначала новые (по умолчанию), asc — сначала старые.Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
profile_post | ProfilePost | Объект записи профиля ProfilePost. |
comments | ProfilePostComment[] | Комментарии выбранной страницы. Возвращается только при with_comments=1. |
pagination | pagination | Метаданные страницы: current_page, last_page, per_page, shown, total. Размер страницы определяется настройками форума. Возвращается только при with_comments=1. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/profile-posts/123/?with_comments=1&page=1'
{
"profile_post": {
"profile_post_id": 123
},
"comments": [
{
"profile_post_comment_id": 123
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}