Sample — Referencia API
API ficticia
Los endpoints siguientes no existen; solo demuestran el estilo de una referencia CR Labz.
Autenticación
Section titled “Autenticación”Todas las peticiones requieren cabecera Authorization: Bearer <token>.
GET /v1/projects HTTP/1.1Host: api.demo.crlabz.comAuthorization: Bearer cr_live_xxxEndpoints
Section titled “Endpoints”GET /v1/projects
Section titled “GET /v1/projects”Lista proyectos del workspace actual.
Parámetros de query
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
limit | number | No | Máximo 50, default 20 |
cursor | string | No | Paginación cursor-based |
curl -s "https://api.demo.crlabz.com/v1/projects?limit=10" \ -H "Authorization: Bearer cr_live_xxx"{ "data": [ { "id": "prj_01", "name": "Portal clientes", "status": "active" }, { "id": "prj_02", "name": "Docs internas", "status": "active" } ], "next_cursor": "eyJpZCI6InByal8wMiJ9"}{ "error": { "code": "unauthorized", "message": "Token inválido o expirado" }}POST /v1/deployments
Section titled “POST /v1/deployments”Crea un despliegue para un proyecto.
Body (JSON)
| Campo | Tipo | Requerido |
|---|---|---|
project_id | string | Sí |
ref | string | Sí (rama o tag) |
{ "project_id": "prj_01", "ref": "main"}Respuesta típica
201 Created con deployment.id y URL de preview cuando el entorno lo soporte.
DELETE /v1/deployments/:id
Section titled “DELETE /v1/deployments/:id”Cancela un despliegue en cola. Idempotente si ya finalizó.
Códigos de error
Section titled “Códigos de error”| HTTP | code | Significado |
|---|---|---|
| 400 | invalid_request | Body o query mal formados |
| 401 | unauthorized | Token ausente o inválido |
| 429 | rate_limited | Demasiadas peticiones |
| 500 | internal_error | Error del servidor |
Siguiente paso
Section titled “Siguiente paso”Vuelve al índice de samples o abre el showcase para comparar componentes visuales.