메인 콘텐츠로 건너뛰기
Header

​
개요

Twenty API는 개발자가 Twenty CRM 플랫폼과 프로그래밍적으로 상호작용하도록 허용합니다. API를 사용하여 Twenty와 다른 시스템을 통합하고, 데이터 동기화를 자동화하며, 고객 데이터를 중심으로 맞춤 솔루션을 구축할 수 있습니다. API는 핵심 CRM 객체(사람 및 회사와 같은)의 생성, 읽기, 업데이트 및 삭제뿐만 아니라 메타데이터 구성에 대한 접근을 제공합니다. API 플레이그라운드: 이제 앱의 설정 내에 있는 API 플레이그라운드에 접근할 수 있습니다. 실시간으로 API 호출을 시도하려면 Twenty 작업 공간에 로그인하고 설정 → API 및 Webhooks로 이동하세요. 이렇게 하면 앱 내 API 플레이그라운드와 API 키 설정이 열립니다. API 설정으로 이동

​
인증

Twenty의 API는 인증을 위해 API 키를 사용합니다. 보호된 엔드포인트에 대한 모든 요청은 헤더에 API 키를 포함해야 합니다.
  • API 키: Twenty 앱의 API 설정 페이지에서 새 API 키를 생성할 수 있습니다. 각 API 키는 CRM 데이터에 대한 액세스를 제공하는 비밀 토큰이므로 안전하게 보관하세요. 키가 손상된 경우 설정에서 해지하고 새 키를 생성하세요.
  • Auth 헤더: API 키를 얻은 후 HTTP 요청의 Authorization 헤더에 포함하세요. Bearer 토큰 스키마를 사용하세요. 예를 들어: 
    Authorization: Bearer YOUR_API_KEY
    YOUR_API_KEY를 얻은 키로 바꾸세요. 이 헤더는 모든 API 요청에 포함되어야 합니다. 토큰이 누락되거나 유효하지 않은 경우, API는 인증 오류(HTTP 401 Unauthorized)로 응답합니다.

​
API 엔드포인트

모든 리소스는 REST 또는 GraphQL을 통해 접근할 수 있습니다.
  • 클라우드: https://api.twenty.com/ 또는 사용자 지정 도메인/서브도메인
  • Self-Hosted Instances: If you are running Twenty on your own server, use your own domain in place of api.twenty.com (for example, https://{your-domain}/rest/).
엔드포인트는 두 가지 카테고리로 그룹화됩니다: Core API와 메타데이터 API. Core API는 주요 CRM 데이터(예: 사람, 회사, 메모, 작업)를 다루고, 메타데이터 API는 구성 데이터(예: 사용자 정의 필드 또는 객체 정의)를 다룹니다. 대부분의 통합은 주로 Core API를 사용합니다.

​
Core API

/rest/ 또는 /graphql/에서 접근할 수 있습니다. Core API는 주요 CRM 엔티티(사람, 회사, 메모, 작업)와 그 관계를 관리하기 위한 통합 인터페이스를 제공하며, REST 및 GraphQL 상호작용 모델을 제공한다.

​
메타데이터 API

/rest/metadata/ 또는 /metadata/에서 접근할 수 있습니다. 메타데이터 API 엔드포인트는 스키마와 설정에 대한 정보를 가져오도록 허용합니다. 예를 들어, 사용자 정의 필드, 객체 스키마 등의 정의를 가져올 수 있습니다.
  • 엔드포인트 예시:
    • GET /rest/metadata/objects – 모든 객체 유형과 그 메타데이터(필드, 관계) 나열.
    • GET /rest/metadata/objects/{objectName} – 특정 객체(예: 사람들, 회사)에 대한 메타데이터 가져오기.
    • GET /rest/metadata/picklists – CRM에 정의된 피클리스트(드롭다운) 필드 옵션을 가져오기.
일반적으로 메타데이터 엔드포인트는 데이터 구조(동적 통합 또는 양식 작성)를 이해하기 위해 사용되며 실제 기록을 관리하는 데 사용되지 않습니다. 대부분의 경우 읽기 전용입니다. 이들 역시 인증이 필요합니다(귀하의 API 키 사용).