Documentation des points de terminaison du serveur JSON:API
Documentation des points de terminaison du serveur JSON:API
Filtres
Filtrer les articles par ID de tag
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.meta.drupal_internal__tid]=2
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.meta.drupal_internal__tid] | 2 |
Filtrer les articles par UUID de tag
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created&filter[field_tags.id]=f203b178-3672-4312-b974-4fb5ea8b35cb
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| include | field_image,field_tags |
| sort | -created |
| filter[field_tags.id] | f203b178-3672-4312-b974-4fb5ea8b35cb |
Filtrer les articles par titre
GET
{{host}}/jsonapi/node/article?filter[title]=Drupal CMS
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[title] | Drupal CMS |
Filtrer les articles par titre (correspondance partielle)
GET
{{host}}/jsonapi/node/article?filter[title][value]=Drupal&filter[title][operator]=CONTAINS
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[title][value] | Drupal |
| filter[title][operator] | CONTAINS |
Filtrer les articles par statut publié
GET
{{host}}/jsonapi/node/article?filter[status]=1
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[status] | 1 |
Articles créés après le 1er janvier 2024
GET
{{host}}/jsonapi/node/article?filter[created][value]=2024-01-01T00:00:00&filter[created][operator]=>=
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[created][value] | 2024-01-01T00:00:00 |
| filter[created][operator] | >= |
Pagination
GET
{{host}}/jsonapi/node/article?page[limit]=5&page[offset]=0
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| page[limit] | 5 |
| page[offset] | 0 |
Combiner les filtres (logique ET)
GET
{{host}}/jsonapi/node/article?filter[status]=1&filter[field_tags.meta.drupal_internal__tid]=5
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[status] | 1 |
| filter[field_tags.meta.drupal_internal__tid] | 5 |
Tags
Obtenir les tags
GET
{{host}}/jsonapi/taxonomy_term/tags?sort=name&fields[taxonomy_term--tags]=name,drupal_internal__tid
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| sort | name |
| fields[taxonomy_term--tags] | name,drupal_internal__tid |
Articles
Liste des articles
GET
{{host}}/jsonapi/node/article?include=field_image,field_tags&sort=-created
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| include | field_image,field_tags |
| sort | -created |
Image d'article
GET
{{host}}/jsonapi/node/article/b26c80d2-155c-4c7e-9135-5a4011e2ae17/field_image?resourceVersion=id%3A5
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| resourceVersion | id:5 |
Menu
Menu principal
GET
{{host}}/jsonapi/menu_items/main
Pages
Page par ID
GET
{{host}}/jsonapi/node/page?filter[nid][value]=4
Paramètres de requête :
| Paramètre | Valeur |
|---|---|
| filter[nid][value] | 4 |
Page par UUID
GET
{{host}}/jsonapi/node/page/8b53db13-613e-45c4-80d7-dc81eba75f11
Webformulaire
Webformulaire
GET
{{host}}/webform/contact
En-tĂŞtes :
| Clé | Valeur |
|---|---|
| content-type | application/json |
Webformulaire REST
POST
{{host}}/webform_rest/submit
En-tĂŞtes :
| Clé | Valeur |
|---|---|
| Content-Type | application/json |
Corps de la requĂŞte :
{
"webform_id": "contact",
"name": "Ivan Abramenko",
"subject": "Test de soumission Webform",
"email": "levmyshkin89@gmail.com",
"message": "Test de soumission Webform"
}
Authentification
Authentification par clé API
Tous les points de terminaison nécessitent une authentification par clé API utilisant l'en-tête suivant :
| En-tĂŞte | Valeur |
|---|---|
| X-API-Key | {{token}} |