Vue d’ensemble de l’API

L’API REST publique d’iyedy sert vos schémas, vues, contrôles, graphe des dépendances et propositions à vos scripts et à votre CI, avec un jeton et ses portées.

L’API publique est une API REST en HTTPS. Un script, une tâche de CI ou un agent l’appelle avec un jeton et reçoit du JSON. Elle lit ce que votre compte peut lire et fait ce que vos rôles permettent, rien de plus.

Adresse de base et description

• Adresse de base : https://app.iyedy.com/v1.
• Description : le document OpenAPI 3.1 de toutes les routes se trouve à https://app.iyedy.com/v1/openapi.json. Chargez-le dans votre outil d’API pour parcourir les routes et leurs schémas de données.
• Où vous travaillez : la plupart des routes sont sous une organisation et un espace de travail, /v1/t/{tenantId}/w/{workspaceId}/…. GET /v1/token vous donne les deux identifiants de votre jeton : voir Votre premier appel à l’API.

Ce que vous pouvez faire

Portées et rôles se combinent : une portée ouvre une route, et votre rôle dans l’espace de travail décide toujours. Une portée cartouche.write sur le jeton d’un lecteur n’écrit rien. Voir Portées.

Ce que l’API ne fait pas

• Pas d’administration. Un jeton ne crée jamais de jetons, ne gère ni membres ni réglages, n’ouvre pas la connexion en direct de l’app, ne lance pas l’Assistant et n’exporte pas une bibliothèque entière.
• Pas de décision sur une proposition. Appliquer ou refuser une proposition se fait dans l’app, par une personne.
• Pas de webhooks ni d’application GitHub. iyedy n’appelle pas vos systèmes ; ce sont vos tâches qui appellent iyedy. Voir Intégrations.
• Pas encore d’outil en ligne de commande à installer. Voir Outil en ligne de commande.

Jetons

Chaque requête porte un jeton dans l’en-tête Authorization: Bearer. Un jeton d’accès personnel (crt_pat_…) agit en tant que vous. Un jeton de compte de service (crt_sa_…) agit en tant que compte de service de votre organisation, pour la CI. Sur une requête avec jeton, un cookie de session est ignoré. Voir Créer et gérer des jetons d’API et Comptes de service.

Conventions

• Les erreurs sont en JSON : un objet error avec code, message, detail et requestId. Une lecture qui ne vous est pas permise répond 404, comme une ressource qui n’existe pas. Voir Limites de débit et erreurs.
• Les listes prennent limit (200 au plus) et cursor, et répondent les éléments avec un nextCursor.
• Les reprises : envoyez un en-tête Idempotency-Key sur un POST qui crée ; une répétition dans les 24 heures reçoit la réponse enregistrée.
• Les versions : les changements dans /v1 ne font qu’ajouter. Un changement incompatible arriverait en /v2, avec 12 mois de recouvrement et des en-têtes Deprecation et Sunset sur les anciennes routes.

Ce que cela change pour vous

Servez-vous de l’API pour faire entrer iyedy dans les outils que vous utilisez déjà : exporter les vues que montre votre documentation, lancer les contrôles dans un pipeline, suivre ce qui dépend d’un composant avant de le changer. Pour modifier un schéma depuis une tâche, préférez une proposition : une personne reste dans la boucle. Commencez par Votre premier appel à l’API.