Organizations

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.

Common Use Cases

• Crear una nueva organización para tu empresa
• Administración de ajustes de organización
• Actualización de información de organización
• Obtención de detalles de organización

Puntos finales

GET

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

Obtener información de la organización. Si orgId Devuelve una sola organización si se proporciona en los parámetros, de lo contrario devuelve todas las organizaciones accesibles.

Sección titulada “Parámetros de consulta”

• orgId (opcional): El ID de la organización específica a 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 "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

# Get specific organization
curl -H "x-api-key: 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.

Cuando se utiliza una clave API, la clave debe tener el alcance global org.create permiso y una organización actual org_admin permiso org_super_admin Cuando el pedido tiene éxito, __CAPGO_KEEP_0__ asigna automáticamente la misma clave __CAPGO_KEEP_1__ como

Cuando la solicitud tiene éxito, Capgo asigna automáticamente la misma clave de API org_super_admin en la nueva organización.

Note

org.create No se concede por defecto a nuevas claves API. Habilita Permitir crear organizaciones en la forma de la clave API, o incluir "global_permissions": ["org.create"] al crear la clave a través del API.

Cuerpo de la solicitud

interface OrganizationCreate {
  name: string
  email?: string
  estimatedMau?: number
  website?: string
}

Solicitud de ejemplo

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization",
    "email": "admin@example.com",
    "website": "https://example.com"
  }' \
  https://api.capgo.app/organization/

Respuesta de ejemplo

{
  "id": "org_456"
}

Error de permiso

Si la clave API no tiene org.createla API devuelve:

{
  "error": "permission_denied"
}

PUT

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

Actualizar una organización existente. Requiere rol de administrador en la organización objetivo.

Cuerpo de la solicitud

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

Solicitud de ejemplo

curl -X PUT \
  -H "x-api-key: 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 permiso de eliminación en la organización objetivo, típicamente a través del org_super_admin rol. Esta acción es irreversible y eliminará todos los aplicativos asociados, conjuntos (versiones) y recursos.

El org.create permiso global no permite eliminar organizaciones.

Parámetros de consulta

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

Pedido de ejemplo

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

Respuesta de ejemplo

{
  "status": "ok"
}

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. Roles: Asigne roles adecuados a los miembros del equipo
3. Email: Use a group email for management_email to avoid issues with personal email changes
4. Logo: Alcance logos en un CDN confiable y utilice URLs HTTPS

Sigue adelante desde Organizaciones

Si estás utilizando Organizaciones para planificar la consola y las operaciones de API, conecta con API Resumen para obtener detalles de implementación en API Resumen, Introducción para obtener detalles de implementación en Introducción, API Claves para obtener detalles de implementación en API Claves, Dispositivos para obtener detalles de implementación en Dispositivos, y Paquetes para los detalles de implementación en Paquetes.