Référence de l’API

Documentation développeur pour accéder à Architecto par programmation

L’API Architecto permet de créer des applications, intégrations et processus personnalisés sur la plateforme.

Authentification

Toutes les requêtes nécessitent une authentification par clé d’API :

Authorization: Bearer YOUR_API_KEY

Créer une clé d’API

Ouvrez Paramètres → Développeur → Clés d’API.
Cliquez sur Créer une clé.
Indiquez le nom et l’expiration : jamais, 30 jours, 90 jours ou 1 an.
Choisissez les portées : lecture, écriture ou administration.
Copiez la clé, affichée une seule fois.

Ne partagez jamais publiquement votre clé. Traitez-la comme un mot de passe.

Révoquer une clé d’API

Ouvrez Paramètres → Développeur → Clés d’API.
Cliquez sur Révoquer à côté de la clé.
La révocation est immédiate.

URL de base

Tous les points d’accès sont disponibles ici :

https://api.architecto.dev/v1

Points d’accès courants

Authentification

POST /auth/login          # Login and get session
POST /auth/logout         # End session
POST /auth/refresh        # Refresh access token

Architectures

GET    /architectures              # List your architectures
POST   /architectures              # Create new architecture
GET    /architectures/{id}         # Get architecture details
PUT    /architectures/{id}         # Update architecture
DELETE /architectures/{id}         # Delete architecture
GET    /architectures/{id}/versions # Get version history

Analyse

POST   /architectures/{id}/analyze/cost         # Run cost analysis
POST   /architectures/{id}/analyze/scalability  # Run scalability analysis
POST   /architectures/{id}/analyze/threats      # Run threat modeling

Documentation

POST   /architectures/{id}/documents/rfc        # Generate RFC
POST   /architectures/{id}/documents/adr        # Generate ADR
POST   /architectures/{id}/documents/runbook    # Generate runbook

POST   /architectures/{id}/shares      # Create share link
GET    /shares/{token}                 # Get shared architecture
POST   /shares/{token}/comments        # Add comment to shared arch

Équipes

GET    /organizations                  # List your organizations
POST   /organizations                  # Create organization
GET    /organizations/{id}/members     # List team members
POST   /organizations/{id}/invites     # Invite team member

Gestion des erreurs

L’API renvoie les codes d’état HTTP standard :

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Architecture with id 'arch_123' not found",
    "details": {
      "resource_type": "architecture",
      "resource_id": "arch_123"
    }
  }
}

Codes d’état courants

Code	Signification
200	Réussite
400	Requête incorrecte : paramètres invalides
401	Non authentifié : clé d’API invalide
403	Interdit : droits insuffisants
404	Introuvable
429	Limite de requêtes atteinte
500	Erreur du serveur

Limitation des requêtes

Les limites sont les suivantes :

Forfait Free : 100 requêtes par heure.
Forfait Pro : 1,000 requêtes par heure.
Forfait Ultimate : 10,000 requêtes par heure.

Les en-têtes de réponse indiquent ces limites :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Exemple : créer et analyser une architecture

# 1. Create architecture
curl -X POST https://api.architecto.dev/v1/architectures \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "E-commerce Platform",
    "description": "Multi-region e-commerce with real-time inventory",
    "cloud_provider": "aws"
  }'

# Response:
# {
#   "id": "arch_abc123",
#   "title": "E-commerce Platform",
#   "created_at": "2024-01-15T10:30:00Z"
# }

# 2. Run cost analysis
curl -X POST https://api.architecto.dev/v1/architectures/arch_abc123/analyze/cost \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scale_points": [1000, 10000, 100000],
    "region": "us-east-1"
  }'

# Response:
# {
#   "analysis_id": "analysis_xyz789",
#   "estimates": [
#     {
#       "users": 1000,
#       "monthly_cost": 150,
#       "breakdown": { "compute": 80, "storage": 40, "data_transfer": 30 }
#     },
#     ...
#   ]
# }

Webhooks : bientôt disponibles

Abonnez-vous aux événements d’architecture :

POST /webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["architecture.created", "architecture.updated", "analysis.completed"]
}

SDK

Des SDK officiels sont prévus pour :

Python
Node.js / TypeScript
Go
Ruby
Java

Documentation interactive de l’API

Essayez l’API sans écrire de code :

Assistance

Problèmes d’API : signalez-les dans GitHub Issues.
Questions : posez-les sur le Discord de la communauté.
Entreprises : contactez sales@architecto.dev.

Étapes suivantes :

Guide des intégrations
Configuration des webhooks (bientôt)

Référence de l’API

Sur cette page