Connecteur API-JSON

Le connecteur API-JSON est un connecteur avancé, il permet d'indexer automatiquement du contenu venant d'une API-JSON public. Il permet de créer un document personnalisable basé sur les données venant d'une API JSON.

Informations nécessaires :

Nom du champ	Valeur	Commentaire
URLs		l'URL ou les URLs à indexer
Format du document		permet de créer un modèle de fichier prennant en charge le markdown et le format mustache
Format de l'URL		permet de créer un modèle pour l'url source de la page prennant en charge le markdown et le format mustache
Chemin du tableau		permet de cibler un tableau chaque objet sera un document

Prérequis du connecteur :

L'APi doit retourner un JSON au format :

[
  {
    "title": "mon titre",
    "content": "mon content",
    {...},
    [...]
  },
  {
    "title": "mon titre 2",
    "content": "mon content 2",
    {...},
    [...]
  }
]

ou comme ci-dessous :

[
  {

    "info": [
      { 
	      "title": "mon titre",
        "content": "mon content"
      }
    ]
  },
  ...
  ]

FAQ

Comment configurer mon connecteur ?

Une URL ou les URLs d’une API qui retourne du JSON avec des tableaux sur lesquels nous pouvons réaliser une boucle.

Voici un exemple de retour d’API :

[
  {
    "title": "mon titre",
    "content": "mon content",
    {...},
    [...]
  },
  {
    "title": "mon titre 2",
    "content": "mon content 2",
    {...},
    [...]
  }
]

Grâce au template Mustache on peut construire notre futur document.

Exemple de template simple :

mon titre :  {{{title}}}
contenu de la page : {{{content}}}
description : {{{xxxx.xxxx.description}}}

On peut aussi cibler un tableau dans une réponse d’API.

Exemple : je veux récupérer les paragraphes dans le retour suivant :

[
  {
    "title": "mon-titre",
    "content": "mon content",
    {...},
    "paragraphes"[...]
  },
  {
    "title": "mon-titre-2",
    "content": "mon content 2",
    {...},
    "paragraphes"[...]
  }
]

Je peux mettre dans le champ chemin du tableau cible : paragraphes Le connecteur va créer un document par paragraphes.

Pour l’URL de la source, même fonctionnement que pour le template, on peut utiliser des {{{}}}

exemple :

https://monSite.com/{{{tite}}}
//https://monSite.com/mon-titre

Pour aller plus loin dans les templates Mustache ⇒ https://mustache.github.io/mustache.5.html