Documentación viva
Swagger y ReDoc se sirven desde el propio servicio, con los ficheros en local: sin CDN y sin depender de que un tercero siga en pie.
Atlas
La API real, leída ahora mismo del servicio.
Esta página no enseña una lista escrita a mano. Pide el contrato OpenAPI a api_script en el momento en que la abres y dibuja lo que responde. Si mañana hay un endpoint más, aparece aquí sin que nadie toque esta página. Y si el servicio no contesta, lo dice —en vez de enseñar un mapa viejo que ya no corresponde.
El recorrido
Un documento entero son seis llamadas.
No hace falta recorrer las 149 para entender qué hace el servicio. Éstas son las que hace el taller cuando alguien pulsa, en este orden. La marca de la derecha se comprueba contra el contrato en vivo: si una dejara de existir, aquí lo verías.
-
1
Crear la obra
Elige plantilla y biblioteca ancla. Cuesta 1 pibiCash.
POST /api/v1/obras -
2
Fijar las fuentes
Lo que el modelo podrá leer, y nada más. Es la puerta de la trazabilidad.
POST /api/v1/obras/{obra_id}/sources -
3
Levantar el índice
La plantilla trae la estructura; aquí se lee y se puede reordenar.
GET /api/v1/obras/{obra_id}/units -
4
Pre-vuelo
Qué falta y cuánto va a costar, antes de gastar nada.
GET /api/v1/obras/{obra_id}/preflight -
5
Generar, unidad a unidad
Responde por eventos: etapa, texto según llega, fuentes citadas y fin. 1,91 pibiCash de media.
POST …/units/{unit_id}/generate -
6
Exportar
Cualquiera de los formatos de su tipo, sin regenerar. 1 pibiCash.
GET /api/v1/obras/{obra_id}/export
El contrato
Y aquí está entero, familia por familia.
Lo que sigue no lo hemos escrito nosotros: es lo que api_script declara en su OpenAPI, pedido al abrir esta página. Filtra por ruta, método o descripción, o entra por una familia.
Diecinueve familias. Pulsa una para filtrar la lista.
Pidiendo el contrato al servicio…
Cómo leerlo: las operaciones marcadas como públicas responden sin sesión —salud, el arranque del inicio de sesión y el disparador por webhook de un flujo, que va protegido por un secreto en la propia URL—; son las que aparecen ahí arriba. Todo lo
demás exige la cookie de sesión de pibiCo y respeta los permisos por biblioteca del repositorio de
origen: tener el endpoint no da acceso al documento. Un matiz honesto: el contrato sólo declara security en — de las operaciones, porque api_script resuelve la sesión por
dependencia y FastAPI no lo refleja ahí. El recuento de públicas de esta página no sale de ese campo: se deduce de las operaciones que no declaran sesión, y por eso publicamos ese número y no el contrario.
Para integrarlo
Todo lo que hace el taller, lo puede disparar tu ERP.
Todo lo que se puede hacer pulsando se puede hacer llamando: crear la obra, fijar las fuentes, levantar el índice, generar en directo y exportar. Es lo que permite que el informe mensual lo dispare tu ERP en vez de una persona.
Generación en directo
La generación se sirve por eventos: etapa, texto según llega, fuentes citadas y fin. Un cliente puede enseñar el borrador escribiéndose, no esperar dos minutos a un JSON.
Disparadores
Un flujo guardado se lanza a mano, en cadencia o por webhook con secreto en la ruta. Es el gancho para que lo dispare otro sistema sin repartir credenciales.