Portail développeur et documentation vivante

English version: ../../en/guides/developer-portal.md

La rubrique Portail développeur du portail donne à un développeur ce que la plateforme fournit à une application ou à un agent, les contrats et leur validation en direct, la référence API, des extraits SDK et le catalogue des briques. Chaque page lit le Control Plane : rien n'est recopié à la main. Qui : développeurs. Code de l'écran : portal/src/screens/developer.tsx.

Sources

Le portail lit les contrats (GET /v1/contracts) et les valide en direct (POST /v1/contracts/{name}/validate) dans portal/src/screens/developer.tsx, et pointe vers le schéma OpenAPI publié. Rien n'est recopié à la main : docs/api/openapi-v1.json et docs/sdks/cli-reference.md sont générés et vérifiés en CI.

enterprise-ai docs --write cli-reference.md

Page	Ce qu'elle montre	Source
Portail développeur > Kit développeur	les ressources que la plateforme fournit à une application, un agent ou un projet, leur état, le fichier d'environnement et des extraits SDK	GET /v1/developer/kit
Portail développeur > Contrats	les schémas JSON des contrats v1 et un outil de validation	GET /v1/contracts, POST /v1/contracts/{name}/validate
Portail développeur > Référence API	des liens vers /docs, /redoc et /openapi.json du Control Plane et sa version	GET /v1/meta
Portail développeur > Démarrage SDK	ligne d'installation et démarrage rapide de chaque SDK	extraits du portail
Portail développeur > Catalogue des briques	les briques de la plateforme	GET /v1/catalog/bricks
Portail développeur > Feuille de route	les phases de livraison de la plateforme	le portail

Procédures

1. Obtenir le kit de votre application ou de votre agent. Le kit liste chaque ressource fournie par la plateforme (passerelle LLM, identité, permissions et politiques, protection des données, traçabilité IA, outils métier, accès aux documents, SDK, tests de qualité et de sécurité) avec sa valeur, son état et l'action qui la corrige.

   Écran : Portail développeur > Kit développeur, choisissez une application, un agent ou un projet.

   Résultat attendu : chaque ligne est Prêt ; le résumé indique combien de ressources sont prêtes.

   En cas d'échec : une ligne Non configuré ou Service non installé donne la page qui corrige ; une liste vide signale qu'aucune application ni aucun agent n'est encore enregistré (enregistrez-en un dans Agents > Applications ou Agents > Registre).

2. Télécharger le fichier d'environnement. Il contient les variables de votre application pour la passerelle, l'OIDC, la DLP, la passerelle MCP, OTLP et Opik ; il ne contient jamais de secret.

   Écran : Kit développeur, onglet du fichier d'environnement, Télécharger le .env.

   Résultat attendu : un fichier .env ; collez-y vous-même la clé de projet.

   En cas d'échec : créez d'abord une clé de projet (la clé s'affiche une seule fois à la création).

3. Valider un document selon un contrat. Vous vérifiez un manifeste ou un contexte avant de l'envoyer, avec le même schéma que celui qu'applique le Control Plane.

   Écran : Portail développeur > Contrats, choisissez le contrat, collez le document JSON et validez-le.

   Résultat attendu : le document est valide, ou chaque erreur est listée avec son chemin.

   En cas d'échec : un texte JSON invalide est signalé avant tout appel ; corrigez la syntaxe.

4. Ouvrir la référence API. Écran : Portail développeur > Référence API. Voir la Référence API pour les deux API de la plateforme.

   Résultat attendu : la console interactive et la référence de votre Control Plane s'ouvrent dans un nouvel onglet.

   En cas d'échec : la documentation est désactivée sur ce serveur ; lisez plutôt docs/api/control-plane-v1.md.

5. Régénérer la référence de la CLI (contributeurs). Elle garde docs/sdks/cli-reference.md égale à la CLI réelle.

   Résultat attendu : enterprise-ai docs --write cli-reference.md écrit le fichier ; le contrôle de la CI passe.

   En cas d'échec : le contrôle de tools/cli/gen_reference.py signale une page périmée ; régénérez-la et validez-la dans le dépôt.

Marketplace

Une fiche de pack (GET /v1/marketplace/packages/{name}) et sa version (GET /v1/marketplace/packages/{name}/versions/{version}) portent le manifeste ; POST /v1/marketplace/preflight renvoie capacités demandées et configuration requise avant installation. Voir le guide Marketplace.

Exemples exécutables

Les extraits Python et CLI sont exécutés par sdks/python/tests/test_governance_clients.py ; les extraits TypeScript, Go et Java des guides SDK sont compilés par services/control-plane/tests/test_developer_guides.py.

Dépannage

Symptôme	Cause	Correction
Une page affiche 403 forbidden	votre rôle ne peut pas l'ouvrir	demandez le rôle de details.required_roles
Contrats est vide	aucun contrat publié par le serveur	vérifiez GET /v1/contracts avec votre clé
Une ligne du kit est Service non installé	le service n'est pas installé par le Navin Manager	installez-le depuis le Navin Manager, puis actualisez
la réponse porte "valid": false	le document enfreint le contrat	corrigez chaque entrée de errors (path, message)
La CI échoue sur docs/sdks/cli-reference.md	référence plus ancienne que la CLI	lancez enterprise-ai docs --write cli-reference.md dans docs/sdks

Étapes suivantes

• Référence API
• Premiers pas
• Guide Marketplace