Organizaciones

Los organismos 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
• Actualizando información de la organización
• Recuperando detalles de la organización

Puntos finales

GET

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

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

Sección titulada “Parámetros de consulta”

• orgId Tipo de respuesta

Si __CAPGO_KEEP_0__ se proporciona en los parámetros, devuelve una sola organización. De lo contrario, devuelve todas las organizaciones accesibles.

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/

Respuesta de ejemplo

{
  "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á todos los aplicativos asociados, conjuntos (versiones) y recursos.

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

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. : Asigne roles adecuados a los miembros del equipo: Utilice un correo electrónico grupal para management_email para evitar problemas con cambios en el correo electrónico personal
3. Utilice un correo electrónico grupal para management_email para evitar problemas con cambios en el correo electrónico personalUtilice un correo electrónico grupal para management_email para evitar problemas con cambios en el correo electrónico personal
4. Logo: Almacena logos en un CDN confiable y utiliza URLs HTTPS