Documentación de puntos finales del servidor JSON:API
Documentación de los Endpoints del Servidor JSON:API
Filtros
Filtrar artículos por ID de etiqueta
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.meta.drupal_internal__tid]=2
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.meta.drupal_internal__tid] | 2 |
Filtrar artículos por UUID de etiqueta
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.id]=f203b178-3672-4312-b974-4fb5ea8b35cb
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.id] | f203b178-3672-4312-b974-4fb5ea8b35cb |
Filtrar artículos por título
GET
{{host}}/jsonapi/node/article?filter[title]=Drupal CMS
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[title] | Drupal CMS |
Filtrar artículos por título (coincidencia parcial)
GET
{{host}}/jsonapi/node/article?filter[title][value]=Drupal&filter[title][operator]=CONTAINS
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[title][value] | Drupal |
| filter[title][operator] | CONTAINS |
Filtrar artículos por estado de publicación
GET
{{host}}/jsonapi/node/article?filter[status]=1
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[status] | 1 |
Artículos creados después del 1 de enero de 2024
GET
{{host}}/jsonapi/node/article?filter[created][value]=2024-01-01T00:00:00&filter[created][operator]=>=
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[created][value] | 2024-01-01T00:00:00 |
| filter[created][operator] | >= |
Paginación
GET
{{host}}/jsonapi/node/article?page[limit]=5&page[offset]=0
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| page[limit] | 5 |
| page[offset] | 0 |
Combinar filtros (lógica AND)
GET
{{host}}/jsonapi/node/article?filter[status]=1&filter[field_tags.meta.drupal_internal__tid]=5
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[status] | 1 |
| filter[field_tags.meta.drupal_internal__tid] | 5 |
Etiquetas
Obtener etiquetas
GET
{{host}}/jsonapi/taxonomy_term/tags?sort=name&fields[taxonomy_term--tags]=name,drupal_internal__tid
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| sort | name |
| fields[taxonomy_term--tags] | name,drupal_internal__tid |
Artículos
Listado de artículos
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| include | field_image,field_tags |
| sort | -created |
Imagen de artículos
GET
{{host}}/jsonapi/node/article/b26c80d2-155c-4c7e-9135-5a4011e2ae17/field_image?resourceVersion=id%3A5
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| resourceVersion | id:5 |
Menú
Menú principal
GET
{{host}}/jsonapi/menu_items/main
Páginas
Nodo página por ID
GET
{{host}}/jsonapi/node/page?filter[nid][value]=4
Parámetros de consulta:
| Parámetro | Valor |
|---|---|
| filter[nid][value] | 4 |
Nodo página por UUID
GET
{{host}}/jsonapi/node/page/8b53db13-613e-45c4-80d7-dc81eba75f11
Formulario Webform
Webform
GET
{{host}}/webform/contact
Encabezados:
| Clave | Valor |
|---|---|
| content-type | application/json |
Envío REST de Webform
POST
{{host}}/webform_rest/submit
Encabezados:
| Clave | Valor |
|---|---|
| Content-Type | application/json |
Cuerpo de la solicitud:
{
"webform_id": "contact",
"name": "Ivan Abramenko",
"subject": "Prueba de envío de Webform",
"email": "levmyshkin89@gmail.com",
"message": "Prueba de envío de Webform"
}
Autenticación
Autenticación mediante clave API
Todos los endpoints requieren autenticación con clave API usando el siguiente encabezado:
| Encabezado | Valor |
|---|---|
| X-API-Key | {{token}} |