Organizations

Las organizaciones son las entidades de nivel superior en Capgo. Le permiten agrupar aplicaciones, miembros del equipo y recursos bajo un mismo paraguas. Cada organización puede tener varios miembros con diferentes roles y permisos.

Casos de uso comunes

• Creación de una nueva organización para su empresa.
• Gestión de la configuración de la organización.
• Actualización de información de la organización.
• Recuperar detalles de la organización.

Puntos finales

OBTENER

https://api.capgo.app/organization/

Recuperar información de la organización. Si se proporciona orgId en los parámetros, devuelve una única organización. De lo contrario, devuelve todas las organizaciones accesibles.

Parámetros de consulta

• orgId (opcional): el ID de la organización específica que se recuperará

Tipo de respuesta

interface Organization {
  id: string
  created_by: string
  created_at: string
  updated_at: string
  logo: string | null
  name: string
  management_email: string
  customer_id: string | null
}

Solicitud de ejemplo

# Get all organizations
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

# Get specific organization
curl -H "authorization: your-api-key" https://api.capgo.app/organization/?orgId=org_123

Ejemplo de respuesta

{
  "data": {
    "id": "org_123",
    "name": "My Company",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "logo": "https://example.com/logo.png",
    "management_email": "admin@example.com",
    "customer_id": "cus_123"
  }
}

PUBLICAR

https://api.capgo.app/organization/

Crea una nueva organización.

Cuerpo de solicitud

interface OrganizationCreate {
  name: string
}

Solicitud de ejemplo

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization"
  }' \
  https://api.capgo.app/organization/

Ejemplo de respuesta

{
  "status": "Organization created",
  "id": "org_456"
}

PONER

https://api.capgo.app/organization/

Actualizar una organización existente. Requiere rol de administrador.

Cuerpo de solicitud

interface OrganizationUpdate {
  orgId: string
  logo?: string
  name?: string
  management_email?: string
}

Solicitud de ejemplo

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }' \
  https://api.capgo.app/organization/

Ejemplo de respuesta

{
  "status": "Organization updated",
  "data": {
    "id": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }
}

BORRAR

https://api.capgo.app/organization/

Eliminar una organización existente. Requiere rol de administrador. Esta acción es irreversible y eliminará todas las aplicaciones, paquetes (versiones) y recursos asociados.

Parámetros de consulta

• orgId: El ID de la organización a eliminar

Solicitud de ejemplo

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/organization/?orgId=org_123

Ejemplo de respuesta

{
  "status": "Organization deleted",
  "id": "org_123"
}

Manejo de errores

Escenarios de error comunes y sus respuestas:

// Invalid API key
{
  "error": "Invalid API key",
  "status": "KO"
}

// Missing required field
{
  "error": "Name is required",
  "status": "KO"
}

// Insufficient permissions
{
  "error": "Admin role required",
  "status": "KO"
}

Mejores prácticas

1. Nombres: utilice nombres claros y descriptivos para las organizaciones.
2. Roles: asigne roles apropiados a los miembros del equipo
3. Correo electrónico: utilice un correo electrónico grupal para Management_email para evitar problemas con los cambios de correo electrónico personal.
4. Logotipo: aloje logotipos en una CDN confiable y use URL HTTPS