Aller au contenu principal

Aperçu de l'API

L'API REST ArchiCore vous permet d'intégrer l'analyse d'architecture dans vos workflows.

URL de Base

https://api.archicore.io/api/v1

Authentification

Toutes les requêtes API nécessitent une authentification avec un token Bearer :

curl -H "Authorization: Bearer VOTRE_CLE_API" \
https://api.archicore.io/api/v1/projects

Consultez Authentification pour les détails sur l'obtention des clés API.

Format de Réponse

Toutes les réponses sont en JSON :

{
"success": true,
"data": { ... }
}

Réponses d'erreur :

{
"success": false,
"error": "Message d'erreur",
"code": "CODE_ERREUR"
}

Codes de Statut HTTP

CodeDescription
200Succès
201Créé
400Mauvaise Requête - Paramètres invalides
401Non Autorisé - Token invalide ou manquant
403Interdit - Permissions insuffisantes
404Non Trouvé
429Trop de Requêtes - Limite de taux dépassée
500Erreur Interne du Serveur

Limites de Taux

NiveauRequêtes/jourRequêtes/minute
Gratuit10010
Pro10 000100
EntrepriseIllimité1 000

Les en-têtes de limite de taux sont inclus dans toutes les réponses :

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Résumé des Endpoints

Projets

MéthodeEndpointDescription
GET/projectsLister tous les projets
POST/projectsCréer un projet
GET/projects/:idObtenir les détails du projet
DELETE/projects/:idSupprimer un projet
POST/projects/:id/indexDéclencher l'indexation

Analyse

MéthodeEndpointDescription
POST/projects/:id/searchRecherche sémantique
POST/projects/:id/askDemander à l'assistant IA
GET/projects/:id/metricsObtenir les métriques du code
GET/projects/:id/securityRésultats de l'analyse de sécurité
POST/projects/:id/analyzeAnalyse d'impact

Webhooks

MéthodeEndpointDescription
GET/webhooksLister les webhooks
POST/webhooksCréer un webhook
DELETE/webhooks/:idSupprimer un webhook

SDKs

SDKs officiels disponibles pour :

  • JavaScript/TypeScript : npm install @archicore/sdk
  • Python : pip install archicore

Exemple Rapide

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: 'VOTRE_CLE_API' });

// Rechercher du code
const results = await client.projects.search('project-id', {
query: 'logique d\'authentification'
});

// Demander à l'IA
const answer = await client.projects.ask('project-id', {
question: 'Comment fonctionne le système d\'authentification ?'
});