Panoramica API

L'API REST di ArchiCore ti permette di integrare l'analisi dell'architettura nei tuoi workflow.

URL Base

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

Autenticazione

Tutte le richieste API richiedono autenticazione usando un token Bearer:

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

Consulta Autenticazione per i dettagli su come ottenere le chiavi API.

Formato Risposta

Tutte le risposte sono in JSON:

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

Risposte di errore:

{
  "success": false,
  "error": "Messaggio di errore",
  "code": "CODICE_ERRORE"
}

Codici di Stato HTTP

Codice	Descrizione
200	Successo
201	Creato
400	Richiesta Errata - Parametri non validi
401	Non Autorizzato - Token non valido o mancante
403	Vietato - Permessi insufficienti
404	Non Trovato
429	Troppe Richieste - Limite di frequenza superato
500	Errore Interno del Server

Limiti di Frequenza

Piano	Richieste/giorno	Richieste/minuto
Gratuito	100	10
Pro	10.000	100
Enterprise	Illimitato	1.000

Gli header dei limiti di frequenza sono inclusi in tutte le risposte:

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

Riepilogo Endpoint

Progetti

Metodo	Endpoint	Descrizione
GET	/projects	Elenco di tutti i progetti
POST	/projects	Crea un progetto
GET	/projects/:id	Dettagli del progetto
DELETE	/projects/:id	Elimina un progetto
POST	/projects/:id/index	Avvia indicizzazione

Analisi

Metodo	Endpoint	Descrizione
POST	/projects/:id/search	Ricerca semantica
POST	/projects/:id/ask	Chiedi all'assistente IA
GET	/projects/:id/metrics	Ottieni metriche del codice
GET	/projects/:id/security	Risultati scansione sicurezza
POST	/projects/:id/analyze	Analisi d'impatto

Webhooks

Metodo	Endpoint	Descrizione
GET	/webhooks	Elenco webhooks
POST	/webhooks	Crea webhook
DELETE	/webhooks/:id	Elimina webhook

SDK

SDK ufficiali disponibili per:

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

Esempio Rapido

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

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

// Cerca codice
const results = await client.projects.search('project-id', {
  query: 'logica di autenticazione'
});

// Chiedi all'IA
const answer = await client.projects.ask('project-id', {
  question: 'Come funziona il sistema di autenticazione?'
});