Organizaciones

Organizations are the top-level entities in Capgo. They allow you to group apps, team members, and resources under a single umbrella. Each organization can have multiple members with different roles and permissions.

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 de conexión

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 Parámetros de consulta

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

• 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 la permiso global y una organización actualmente escopada org.create o org_admin vinculación. Esto es necesario porque la organización objetivo no existe aún, por lo que la RBAC normalmente escopada a la organización no se puede verificar contra ella. org_super_admin Cuando la solicitud tiene éxito, __CAPGO_KEEP_0__ asigna automáticamente la misma clave __CAPGO_KEEP_1__ como

When the request succeeds, Capgo automatically assigns the same API key as org_super_admin Nota

no se concede por defecto a las nuevas claves __CAPGO_KEEP_0__. Habilitar

org.create is not granted to new API keys by default. Enable Permitir crear organizaciones en la forma de clave API, o incluir "global_permissions": ["org.create"] cuando se crea 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.createel 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/

Elimine 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.

permisos de eliminación en la organización objetivo, típicamente a través del rol. Esta acción es irreversible y eliminará todos los aplicativos asociados, conjuntos (versiones) y recursos. org.create No se permite eliminar organizaciones protegidas.

Parámetros de consulta

• orgIdEl ID de la organización a eliminar

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

Manejo 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. LogoCopy to clipboard
4. Best Practices: Almacena logos en un CDN confiable y utiliza URLs HTTPS

Sigue 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 el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.