기관

설치

Capgo의 최상위 엔터티는 조직입니다. 조직은 앱, 팀원 및 리소스를 단일 천장 아래에 그룹화할 수 있습니다. 각 조직은 다중 멤버와 다른 역할 및 권한을 가질 수 있습니다.

일반적인 사용 사례

회사에 새로운 조직 만들기
조직 설정 관리
조직 정보 업데이트
조직 세부 정보 가져오기

엔드포인트

GET

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

조직 정보를 가져옵니다. 파라미터 가 제공되면 단일 조직을 반환합니다. 그렇지 않으면 접근 가능한 모든 조직을 반환합니다. orgId Query Parameters

Query Parameters

orgId Response Type

복사

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
}

__CAPGO_KEEP_0__

# 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

예시 응답

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

__CAPGO_KEEP_0__ 키를 사용할 때, 키는 글로벌

When using an API key, the key must have the global org.create 또는 org_admin 앱플로우 플러그인 또는 org_super_admin 결합. 이 요구 사항은 대상 조직이 아직 존재하지 않기 때문에 일반 조직 범위 RBAC를 대상 조직에 대해 확인할 수 없기 때문입니다.

요청이 성공하면 Capgo은 자동으로 새 조직에 동일한 API 키를 할당합니다. org_super_admin 새 조직에 대한 정보입니다.

__CAPGO_KEEP_0__

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

예시 요청

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/

예시 응답

{
  "id": "org_456"
}

권한 오류

API 키가 없다면 API은: org.create, the API returns:

{
  "error": "permission_denied"
}

PUT

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

기존 조직을 업데이트합니다. 대상 조직에 관리자 권한이 필요합니다.

Request Body

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

터미널 창

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/

__CAPGO_KEEP_0__

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

삭제

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

기존 조직을 삭제합니다. 대상 조직에 대한 삭제 권한이 필요하며, 일반적으로 역할을 통해 제공됩니다. 이 작업은 irreversible하고 모든 관련 앱, 버전, 및 리소스를 삭제합니다. org_super_admin 전역 권한은 조직 삭제를 허용하지 않습니다.

쿼리 매개변수 org.create 삭제할 조직의 ID

예제 요청

orgIdSection titled “DELETE”

Section titled “Query Parameters”

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

예시 응답

{
  "status": "ok"
}

오류 처리

일반 오류 상황 및 응답:

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

최선의 방법

이름 지정: 조직 이름을 명확하고 설명적인 이름으로 지정하세요.
역할: 팀원에게 적절한 역할을 assign하세요.
이메일페이지/영역: Capgo 마케팅 웹사이트. 역할: UI 레이블. 표시되는 곳: page register.astro. 메시지 키 `email_label` (이메일 레이블). | 페이지/영역: 라이브 업데이트 제품 페이지. 역할: UI 레이블. 메시지 키 `live_update_guidance_email_label` (라이브 업데이트 지침 이메일 레이블).
: 관리 이메일을 개인 이메일 변경 문제를 피하기 위해 그룹 이메일을 사용하세요.로고

: 로고를 신뢰할 수 있는 CDN에 호스팅하고 HTTPS URL을 사용하세요.

다음으로 만약에 조직을 사용하여 대시보드와 API 운영을 계획하고 있다면 그것을 API 개요 API 구현 세부 정보를 위한 소개 소개 구현 세부 정보를 위한 API 키 API 키 구현 세부 정보를 위한 장치 장치 구현 세부 정보를 위한, 그리고 패키지 패키지 구현 세부 정보를 위한