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
| Code | Description |
|---|---|
200 | Succès |
201 | Créé |
400 | Mauvaise Requête - Paramètres invalides |
401 | Non Autorisé - Token invalide ou manquant |
403 | Interdit - Permissions insuffisantes |
404 | Non Trouvé |
429 | Trop de Requêtes - Limite de taux dépassée |
500 | Erreur Interne du Serveur |
Limites de Taux
| Niveau | Requêtes/jour | Requêtes/minute |
|---|---|---|
| Gratuit | 100 | 10 |
| Pro | 10 000 | 100 |
| Entreprise | Illimité | 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éthode | Endpoint | Description |
|---|---|---|
GET | /projects | Lister tous les projets |
POST | /projects | Créer un projet |
GET | /projects/:id | Obtenir les détails du projet |
DELETE | /projects/:id | Supprimer un projet |
POST | /projects/:id/index | Déclencher l'indexation |
Analyse
| Méthode | Endpoint | Description |
|---|---|---|
POST | /projects/:id/search | Recherche sémantique |
POST | /projects/:id/ask | Demander à l'assistant IA |
GET | /projects/:id/metrics | Obtenir les métriques du code |
GET | /projects/:id/security | Résultats de l'analyse de sécurité |
POST | /projects/:id/analyze | Analyse d'impact |
Webhooks
| Méthode | Endpoint | Description |
|---|---|---|
GET | /webhooks | Lister les webhooks |
POST | /webhooks | Créer un webhook |
DELETE | /webhooks/:id | Supprimer 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 ?'
});