Descripción General de la API

La API REST de ArchiCore te permite integrar análisis de arquitectura en tus flujos de trabajo.

URL Base

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

Autenticación

Todas las solicitudes a la API requieren autenticación usando un token Bearer:

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

Consulta Autenticación para detalles sobre cómo obtener claves API.

Formato de Respuesta

Todas las respuestas son JSON:

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

Respuestas de error:

{
  "success": false,
  "error": "Mensaje de error",
  "code": "CODIGO_ERROR"
}

Códigos de Estado HTTP

Código	Descripción
200	Éxito
201	Creado
400	Solicitud Incorrecta - Parámetros inválidos
401	No Autorizado - Token inválido o faltante
403	Prohibido - Permisos insuficientes
404	No Encontrado
429	Demasiadas Solicitudes - Límite excedido
500	Error Interno del Servidor

Límites de Tasa

Nivel	Solicitudes/día	Solicitudes/minuto
Gratis	100	10
Pro	10,000	100
Empresa	Ilimitado	1,000

Los headers de límite de tasa se incluyen en todas las respuestas:

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

Resumen de Endpoints

Proyectos

Método	Endpoint	Descripción
GET	/projects	Listar todos los proyectos
POST	/projects	Crear un proyecto
GET	/projects/:id	Obtener detalles del proyecto
DELETE	/projects/:id	Eliminar un proyecto
POST	/projects/:id/index	Iniciar indexación

Análisis

Método	Endpoint	Descripción
POST	/projects/:id/search	Búsqueda semántica
POST	/projects/:id/ask	Preguntar al asistente IA
GET	/projects/:id/metrics	Obtener métricas de código
GET	/projects/:id/security	Resultados de escaneo de seguridad
POST	/projects/:id/analyze	Análisis de impacto

Webhooks

Método	Endpoint	Descripción
GET	/webhooks	Listar webhooks
POST	/webhooks	Crear webhook
DELETE	/webhooks/:id	Eliminar webhook

SDKs

SDKs oficiales disponibles para:

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

Ejemplo Rápido

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

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

// Buscar código
const results = await client.projects.search('project-id', {
  query: 'lógica de autenticación'
});

// Preguntar a la IA
const answer = await client.projects.ask('project-id', {
  question: '¿Cómo funciona el sistema de autenticación?'
});