Connecteur API-JSON

Prérequis

1. Le JSON retourné par l'API doit respecter l'un des deux formats suivants :

[
  {
    "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"
      }
    ]
  },
  ...
  ]

Configuration du connecteur

Le connecteur API-JSON est un connecteur avancé qui permet d'indexer automatiquement du contenu venant d'une API JSON publique. Il permet de créer un document personnalisable, dont le contenu et l'URL source sont construits à partir des données renvoyées par l'API, pour alimenter les sources de données de vos apps Wikit Semantics.

Nom du champ	Format / Type	Obligatoire	Commentaire
URLs	Liste de textes / URL	✅	L'URL ou les URLs de l'API à indexer
Format du document	Texte libre (template Mustache + Markdown)	✅	Permet de créer un modèle de fichier prenant en charge le Markdown et le format Mustache
Format de l'URL	Texte libre (template Mustache)	➖	Permet de créer un modèle pour l'URL source de la page, prenant en charge le Markdown et le format Mustache
Chemin du tableau	Texte libre	➖	Permet de cibler un tableau : chaque objet du tableau sera converti en document

💡 Les champs marqués ✅ sont obligatoires pour que le connecteur puisse fonctionner.

Configuration à réaliser

Construire le template du document (Format du document)

Grâce au template Mustache, on peut construire le futur document à partir des champs renvoyés par l'API.

Exemple de template simple :

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

Cibler un tableau imbriqué (Chemin du tableau)

On peut aussi cibler un tableau imbriqué dans une réponse d'API plutôt que la racine. Par exemple, pour 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 : paragraphes. Le connecteur va créer un document par paragraphe.

Construire le template de l'URL source (Format de l'URL)

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

Fonctionnement du connecteur

• Le connecteur interroge chaque URL configurée et récupère le JSON renvoyé par l'API.
• Il crée un document par élément du tableau ciblé (le tableau racine par défaut, ou le tableau désigné par Chemin du tableau).
• Le contenu de chaque document est généré à partir du template Mustache renseigné dans Format du document.
• L'URL source de chaque document, si renseignée, est générée à partir du template Mustache renseigné dans Format de l'URL.

FAQ

Comment configurer mon connecteur ?

Renseignez une URL ou plusieurs URLs d'une API qui retourne du JSON contenant des tableaux, sur lesquels le connecteur peut réaliser une boucle (voir les deux formats acceptés dans la section Prérequis).

Grâce au template Mustache renseigné dans le champ Format du document, vous construisez ensuite le document qui sera créé pour chaque élément du tableau. Si les données que vous souhaitez indexer se trouvent dans un tableau imbriqué plutôt qu'à la racine de la réponse, utilisez le champ Chemin du tableau pour le cibler. Vous pouvez également générer l'URL source de chaque document grâce à un template Mustache renseigné dans le champ Format de l'URL.

Voir la section Configuration à réaliser ci-dessus pour le détail et des exemples de chacun de ces templates.