JSON:API Server Endpoints Документация
Фильтры
Фильтрация статей по ID тега
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.meta.drupal_internal__tid]=2
Параметры запроса:
| Параметр | Значение |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.meta.drupal_internal__tid] | 2 |
Фильтрация статей по UUID тега
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.id]=f203b178-3672-4312-b974-4fb5ea8b35cb
Параметры запроса:
| Параметр | Значение |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.id] | f203b178-3672-4312-b974-4fb5ea8b35cb |
Фильтрация статей по заголовку
GET
{{host}}/jsonapi/node/article?filter[title]=Drupal CMS
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[title] | Drupal CMS |
Фильтрация по заголовку (частичное совпадение)
GET
{{host}}/jsonapi/node/article?filter[title][value]=Drupal&filter[title][operator]=CONTAINS
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[title][value] | Drupal |
| filter[title][operator] | CONTAINS |
Фильтрация статей по статусу публикации
GET
{{host}}/jsonapi/node/article?filter[status]=1
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[status] | 1 |
Статьи, созданные после 1 января 2024
GET
{{host}}/jsonapi/node/article?filter[created][value]=2024-01-01T00:00:00&filter[created][operator]=>=
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[created][value] | 2024-01-01T00:00:00 |
| filter[created][operator] | >= |
Пагинация
GET
{{host}}/jsonapi/node/article?page[limit]=5&page[offset]=0
Параметры запроса:
| Параметр | Значение |
|---|---|
| page[limit] | 5 |
| page[offset] | 0 |
Комбинированные фильтры (логика AND)
GET
{{host}}/jsonapi/node/article?filter[status]=1&filter[field_tags.meta.drupal_internal__tid]=5
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[status] | 1 |
| filter[field_tags.meta.drupal_internal__tid] | 5 |
Теги
Получить теги
GET
{{host}}/jsonapi/taxonomy_term/tags?sort=name&fields[taxonomy_term--tags]=name,drupal_internal__tid
Параметры запроса:
| Параметр | Значение |
|---|---|
| sort | name |
| fields[taxonomy_term--tags] | name,drupal_internal__tid |
Статьи
Список статей
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created
Параметры запроса:
| Параметр | Значение |
|---|---|
| include | field_image,field_tags |
| sort | -created |
Изображение статьи
GET
{{host}}/jsonapi/node/article/b26c80d2-155c-4c7e-9135-5a4011e2ae17/field_image?resourceVersion=id%3A5
Параметры запроса:
| Параметр | Значение |
|---|---|
| resourceVersion | id:5 |
Меню
Главное меню
GET
{{host}}/jsonapi/menu_items/main
Страницы
Страница по ID
GET
{{host}}/jsonapi/node/page?filter[nid][value]=4
Параметры запроса:
| Параметр | Значение |
|---|---|
| filter[nid][value] | 4 |
Страница по UUID
GET
{{host}}/jsonapi/node/page/8b53db13-613e-45c4-80d7-dc81eba75f11
Веб-форма
Webform
GET
{{host}}/webform/contact
Заголовки:
| Ключ | Значение |
|---|---|
| content-type | application/json |
Webform REST
POST
{{host}}/webform_rest/submit
Заголовки:
| Ключ | Значение |
|---|---|
| Content-Type | application/json |
Тело запроса:
{
"webform_id": "contact",
"name": "Ivan Abramenko",
"subject": "Webform testing submission",
"email": "levmyshkin89@gmail.com",
"message": "Webform testing submission"
}
Аутентификация
Аутентификация с помощью API-ключа
Все конечные точки требуют аутентификацию по API-ключу через следующий заголовок:
| Заголовок | Значение |
|---|---|
| X-API-Key | {{token}} |