Ce parcours utilise une opération du catalogue publié. Il permet de vérifier une clé API, le workspace et les données accessibles sans écrire dans le modèle.
Avant de commencer
- Un workspace accessible et une clé API autorisée à lire les instances.
- Le type
Clientcréé avec le quickstart interface. - L'identifiant du workspace et l'UUID du type Client, récupérés dans l'application.
curlet, pour une lecture plus facile,jq.
Dans Clés API, créez une clé avec les permissions nécessaires. Copiez-la à sa création et conservez-la dans votre gestionnaire de secrets. La clé utilisée dans un script est distincte de votre session navigateur.
1. Préparer les paramètres
export ONTOLOGIE_API_URL="https://api.ontologie-growthsystemes.com"
export ONTOLOGIE_API_KEY="df_REMPLACER_PAR_VOTRE_CLE"
export WORKSPACE_ID="UUID_DU_WORKSPACE"
export CLIENT_TYPE_ID="UUID_DU_TYPE_CLIENT"
Remplacez les trois valeurs de démonstration. L'URL est celle de la production ; utilisez celle de votre environnement si vous travaillez ailleurs. Ne partagez pas la valeur réelle de la clé.
2. Lire une page d'instances
curl --fail-with-body --silent --show-error "$ONTOLOGIE_API_URL/api/v1/object-types/$CLIENT_TYPE_ID/instances" -H "X-API-Key: $ONTOLOGIE_API_KEY" -H "x-workspace-id: $WORKSPACE_ID" | jq .
Le chemin HTTP commence par /api/. /docs/reference/api/ est un chemin de documentation, à ne pas utiliser pour appeler le serveur.
Une réponse réussie contient les instances autorisées pour ce type et le contexte de la requête. Une liste vide peut être un résultat valide. Le détail des paramètres et de la pagination est disponible dans API Manager pour cette opération ; une seule page ne prouve pas que vous avez parcouru tous les clients.
3. Vérifier avec l'interface
- Dans le même workspace, ouvrez Client puis Instances.
- Repérez l'instance
CLI-001créée dans le quickstart interface. - Comparez son identifiant et son nom aux données de la réponse.
- Si elle manque, vérifiez le type ciblé, le périmètre de la clé et les filtres ; consultez Diagnostiquer une donnée absente.
Le panneau de test d'API Manager utilise votre session utilisateur. Un succès dans ce panneau ne garantit pas qu'une clé externe dispose des mêmes droits.
Erreurs courantes
| Code | Vérification |
|---|---|
401 | Clé présente, valide et non révoquée |
403 | Permissions de lecture et accès au workspace |
404 | URL de l'environnement, UUID du type et route publiée |
429 | Limites d'appel et délai avant nouvelle tentative |
Conservez méthode, chemin, code HTTP et identifiant de requête pour le diagnostic. Écartez la clé des captures et journaux partagés.
Résultat attendu et suite
Vous avez réalisé une lecture avec une clé API et comparé le résultat à une instance de l'interface. Ce parcours ne nécessite aucun nettoyage de données.
Pour écrire, vérifiez d'abord que la méthode et le chemin exacts figurent au catalogue publié et consultez leur schéma. L'existence d'un bouton de création dans l'interface ne rend pas automatiquement sa route accessible aux intégrations externes. Voir Référence API et Préparer une action contrôlée.
