Ir al contenido

Referencia de la API de autor

El panel de tu empresa y la CLI de publicación hablan con la misma API, bajo el prefijo /v1. Esta página resume las rutas de autor. Si necesitas el contrato completo, con los esquemas de cada petición y respuesta, pídeselo al equipo de la plataforma.

  • El panel usa tu sesión de autor, que guarda el navegador. No la manejas tú.
  • La CLI usa un token de autor que empieza por apat_, enviado en la cabecera Authorization: Bearer. Es el único mecanismo pensado para scripts.

Las respuestas de error llevan un código (code) y un mensaje. 404 significa que la empresa no existe o que no eres miembro: la API no distingue los dos casos a propósito. 401 es que falta la sesión o el token y 403 que tu rol no permite la acción.

Método y ruta Qué hace
GET /v1/author/companies Lista las empresas donde participas
POST /v1/author/tokens Crea un token; el valor se devuelve una sola vez
GET /v1/author/tokens Lista tus tokens activos, sin su valor
DELETE /v1/author/tokens/{tokenId} Revoca un token
POST /v1/author/invitations/accept Acepta una invitación a una empresa
Método y ruta Qué hace
GET /v1/companies/{companySlug} Datos de la empresa y tu rol
GET /v1/companies/{companySlug}/decks Lista los decks de la empresa
PUT /v1/companies/{companySlug}/decks/{deckId}/versions/{deckVersion} Sube una versión de un deck (la que usa upload)
POST /v1/companies/{companySlug}/decks/{deckId}/transfer Traspasa un deck a otra empresa tuya
POST /v1/companies/{companySlug}/archive Da de baja la empresa
POST /v1/companies/{companySlug}/unarchive La restaura
Método y ruta Qué hace
GET /v1/companies/{companySlug}/students Alumnos con acceso
POST /v1/companies/{companySlug}/students/{accountId}/activation-code Reenvía el código de activación
POST /v1/companies/{companySlug}/grants Da acceso a un deck o conjunto
DELETE /v1/companies/{companySlug}/grants/{grantId} Retira un acceso
Método y ruta Qué hace
GET /v1/companies/{companySlug}/brand Lee el estado de la marca
PUT /v1/companies/{companySlug}/brand Envía una marca a revisión
DELETE /v1/companies/{companySlug}/brand/proposal Descarta los cambios en revisión
GET /v1/companies/{companySlug}/domains Lista los dominios
POST /v1/companies/{companySlug}/domains Añade un dominio
POST /v1/companies/{companySlug}/domains/{domainId}/verify Comprueba los registros DNS ahora
DELETE /v1/companies/{companySlug}/domains/{domainId} Quita un dominio

El contrato del paquete packages/api-contract es la fuente de verdad de rutas y esquemas. Si construyes una automatización propia, apóyate en él y no en esta página, que es un resumen.