Identité
whoami
Retourne l'auteur SPIP (id, nom, statut) associé à la clé API courante.
Aucun paramètre.
Rubriques
list_rubriques
Liste les rubriques. `parent` filtre sur la rubrique parente (0 = racine).
| Paramètre | Type | |
|---|---|---|
parent | integer | null | optionnel |
limite | integer | optionnel |
get_rubrique
Détaille une rubrique (titre, descriptif, texte, statut).
| Paramètre | Type | |
|---|---|---|
id_rubrique | integer | requis |
create_rubrique
Crée une rubrique.
| Paramètre | Type | |
|---|---|---|
titre | string | requis |
id_parent | integer | optionnel |
descriptif | string | null | optionnel |
texte | string | null | optionnel |
update_rubrique
Modifie une rubrique. Seuls les champs fournis sont mis à jour.
| Paramètre | Type | |
|---|---|---|
id_rubrique | integer | requis |
titre | string | null | optionnel |
descriptif | string | null | optionnel |
texte | string | null | optionnel |
Articles
list_articles
Liste les articles.
| Paramètre | Type | |
|---|---|---|
id_rubrique | integer | null | optionnel |
statut | string | null | optionnel |
recherche | string | null | optionnel |
limite | integer | optionnel |
get_article
Détaille un article (tous les champs + auteurs liés).
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
create_article
Crée un article dans une rubrique.
| Paramètre | Type | |
|---|---|---|
id_rubrique | integer | requis |
titre | string | null | optionnel |
soustitre | string | null | optionnel |
descriptif | string | null | optionnel |
chapo | string | null | optionnel |
nom_site | string | null | optionnel |
url_site | string | null | optionnel |
texte | string | null | optionnel |
update_article
Modifie un article. Seuls les champs fournis sont mis à jour.
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
titre | string | null | optionnel |
soustitre | string | null | optionnel |
descriptif | string | null | optionnel |
chapo | string | null | optionnel |
nom_site | string | null | optionnel |
url_site | string | null | optionnel |
texte | string | null | optionnel |
id_rubrique | integer | null | optionnel |
set_article_author
Affecte un auteur à un article (ou le retire si `retirer=True`).
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
id_auteur | integer | requis |
retirer | boolean | optionnel |
set_article_status
Change le workflow d'un article.
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
statut | string | requis |
move_article
Déplace un article dans une autre rubrique (`id_rubrique` cible).
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
id_rubrique | integer | requis |
make_article_page
Transforme un article en **page unique** (plugin SPIP « Pages ») : l'article est sorti de toute rubrique (`id_rubrique = 0`) et servi par le squelette dédié du plugin — typique pour les mentions légales, la page contact, etc.
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
set_article_lang
Affecte la **langue** d'un article (code ISO : `fr`, `en`, `pt_br`, …) et la marque comme explicitement choisie (`langue_choisie`).
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
lang | string | requis |
set_article_translation
Désigne un article comme **traduction d'un autre** (groupe de traduction partagé via `id_trad`), ce qui alimente la navigation entre langues et le **hreflang**.
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
id_traduction_de | integer | null | optionnel |
retirer | boolean | optionnel |
trash_article
Met un article à la corbeille (statut « poubelle »).
| Paramètre | Type | |
|---|---|---|
id_article | integer | requis |
FAQ (JSON-LD)
get_faq
Lit la **FAQ** d'un article (`id_article`) ou d'une rubrique (`id_rubrique`) — fonctionnalité du plugin « Données structurées GEO (JSON-LD) », qui doit être actif sur le site.
| Paramètre | Type | |
|---|---|---|
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
set_faq
**Remplace** la FAQ d'un article (`id_article`) ou d'une rubrique (`id_rubrique`) — plugin « Données structurées GEO (JSON-LD) » requis.
| Paramètre | Type | |
|---|---|---|
questions | array | requis |
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
Médiathèque
add_document_from_url
Ajoute un document/image à SPIP depuis une **URL** (idéal pour une image générée par DALL·E, ou tout lien) : le fichier est **téléchargé** dans SPIP et rattaché à un article (`id_article`) ou une rubrique (`id_rubrique`).
| Paramètre | Type | |
|---|---|---|
url | string | requis |
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
titre | string | null | optionnel |
descriptif | string | null | optionnel |
credits | string | null | optionnel |
mode | string | optionnel |
add_document_from_data
Ajoute un document/image depuis des **données base64**, rattaché à un article ou une rubrique. **Réservé aux petits fichiers (≲ 10 Ko).**
| Paramètre | Type | |
|---|---|---|
filename | string | requis |
content_base64 | string | requis |
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
titre | string | null | optionnel |
descriptif | string | null | optionnel |
credits | string | null | optionnel |
mode | string | optionnel |
taille_attendue | integer | null | optionnel |
sha256 | string | null | optionnel |
list_documents
Liste la médiathèque (documents et images).
| Paramètre | Type | |
|---|---|---|
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
media | string | null | optionnel |
extension | string | null | optionnel |
mode | string | null | optionnel |
recherche | string | null | optionnel |
limite | integer | optionnel |
offset | integer | optionnel |
get_document
Détaille un document et **résout son emplacement** via le connecteur.
| Paramètre | Type | |
|---|---|---|
id_document | integer | requis |
download_document
Télécharge le **binaire** d'un document local et le renvoie encodé en base64.
| Paramètre | Type | |
|---|---|---|
id_document | integer | requis |
unlink_document
**Délie** un document d'un article (`id_article`) ou d'une rubrique (`id_rubrique`) **sans le supprimer** : le fichier et sa fiche restent dans la médiathèque SPIP, et ses rattachements à d'autres objets sont conservés.
| Paramètre | Type | |
|---|---|---|
id_document | integer | requis |
id_article | integer | null | optionnel |
id_rubrique | integer | null | optionnel |
delete_document
Supprime un document de la médiathèque.
| Paramètre | Type | |
|---|---|---|
id_document | integer | requis |
definitif | boolean | optionnel |