Vue d'ensemble de l'API

Archyl fournit une API complète qui vous permet d'intégrer la documentation d'architecture dans vos workflows, outils et pipelines d'automatisation.

Points de terminaison API

Archyl offre deux interfaces API :

API REST

L'API REST fournit un accès complet à toutes les fonctionnalités d'Archyl :

Créer et gérer des projets
Ajouter, mettre à jour et supprimer des éléments d'architecture
Gérer les relations
Gérer les ADRs et la documentation
Exporter les diagrammes

URL de base : https://api.archyl.com/api/v1

Serveur MCP

Le serveur Model Context Protocol (MCP) permet aux assistants IA d'interagir avec votre architecture :

Claude Code, Claude Desktop
Cursor
VS Code avec Copilot
Autres outils compatibles MCP

Point de terminaison SSE : https://api.archyl.com/sse Point de terminaison HTTP : https://api.archyl.com/mcp

Authentification

Toutes les requêtes API nécessitent une authentification via une clé API :

curl -H "X-API-Key: votre-cle-api" \
  https://api.archyl.com/api/v1/projects

Créer des Clés API

Allez dans votre Profil → Clés API
Cliquez sur "Créer une Clé API"
Choisissez les permissions (lecture seule ou lecture-écriture)
Copiez et stockez votre clé en sécurité

Permissions des Clés

Permission	Description
Lecture	Voir les projets, éléments et documentation
Écriture	Créer et modifier projets, éléments, relations

Démarrage Rapide

Lister Vos Projets

curl -X GET \
  -H "X-API-Key: votre-cle-api" \
  https://api.archyl.com/api/v1/projects

Créer un Système

curl -X POST \
  -H "X-API-Key: votre-cle-api" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Plateforme E-commerce",
    "description": "Système e-commerce principal",
    "type": "internal"
  }' \
  https://api.archyl.com/api/v1/projects/{projectId}/systems

Créer une Relation

curl -X POST \
  -H "X-API-Key: votre-cle-api" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceId": "system-1",
    "targetId": "system-2",
    "label": "Envoie les commandes à",
    "technology": "REST/HTTPS"
  }' \
  https://api.archyl.com/api/v1/projects/{projectId}/relationships

Gestion des Erreurs

Les erreurs API retournent des codes de statut HTTP standards :

Code	Description
400	Requête Invalide - Paramètres invalides
401	Non Autorisé - Clé API invalide ou manquante
403	Interdit - Permissions insuffisantes
404	Non Trouvé - La ressource n'existe pas
500	Erreur Interne du Serveur

Les réponses d'erreur incluent des détails :

{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "Le nom est requis",
    "field": "name"
  }
}

SDKs & Bibliothèques

À venir :

SDK JavaScript/TypeScript
SDK Python
SDK Go

Cas d'Utilisation

Intégration CI/CD

Mettre à jour automatiquement l'architecture après les déploiements :

- name: Mettre à jour l'Architecture
  run: |
    curl -X POST \
      -H "X-API-Key: ${{ secrets.ARCHYL_API_KEY }}" \
      https://api.archyl.com/api/v1/projects/$PROJECT_ID/discover

Outillage Personnalisé

Construire des outils internes qui interagissent avec votre architecture :

Validation d'architecture
Vérification de conformité
Génération de documentation

Assistants IA

Utiliser MCP pour permettre aux assistants IA de comprendre et mettre à jour votre architecture :

Poser des questions sur votre architecture
Créer des éléments en langage naturel
Générer automatiquement de la documentation

Documentation API

La documentation API interactive complète est disponible à :

https://api.archyl.com/docs

Cette documentation OpenAPI inclut :

Tous les points de terminaison disponibles
Schémas de requête/réponse
Fonctionnalité d'essai
Exemples d'authentification

Prochaines Étapes

Authentification - Guide détaillé d'authentification
Serveur MCP - Configurer l'intégration avec les assistants IA

Vue d'ensemble de l'API - Archyl Docs