Organizaciones

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

Uso común

• Crear una nueva organización para su empresa
• Administrar ajustes de organización
• Actualizar información de organización
• Obtener detalles de organización

Puntos finales

GET

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

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

Parámetros de consulta

• orgId (opcional): El ID de la organización específica para 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

Respuesta de ejemplo

{
  "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"
  }
}

POST

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

Crear una nueva organización.

Cuerpo de la 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/

Respuesta de ejemplo

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

PUT

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

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

Cuerpo de la 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"
  }
}

ELIMINAR

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

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

Parámetros de consulta

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

Ejemplo de solicitud

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

Respuesta de ejemplo

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

Gestión de errores

Escenarios de errores 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"
}

Prácticas recomendadas

1. Nomenclatura: Utilice nombres claros y descriptivos para organizaciones
2. Papeles: Asigna roles adecuados a los miembros del equipo
3. Correo electrónico: Utiliza un correo electrónico de grupo para management_email para evitar problemas con cambios en el correo electrónico personal
4. Logo: Alquila logos en un CDN confiable y utiliza URLs HTTPS

Sigue adelante desde Organizaciones

Si estás utilizando Organizaciones para planificar la consola de instrumentos y API operaciones, conecta con API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.