API 개요

Twenty는 개발자 친화적으로 설계되어 있으며, 맞춤형 데이터 모델에 적합한 강력한 API를 제공합니다. 우리는 여러 통합 요구에 맞는 네 가지 고유한 API 유형을 제공합니다.

​

개발자 우선 접근 방식

Twenty는 귀하의 데이터 모델에 맞는 API를 특별히 생성합니다. 즉:

• 긴 ID가 필요하지 않습니다: 객체 및 필드 이름을 직접 엔드포인트에 사용합니다.
• 표준 및 사용자 정의 객체가 동등하게 처리됩니다: 내장된 객체와 동일한 API 처리를 사용자 정의 객체에도 제공합니다.
• 전용 엔드포인트: 각 객체와 필드에 자체 API 엔드포인트가 할당됩니다.
• 맞춤형 문서: 작업 공간의 데이터 모델에 맞게 특별히 생성됩니다.

​

네 가지 API 유형

Twenty는 REST 및 GraphQL 형식으로 API를 제공합니다:

​

REST API

​

1. REST 메타데이터 API

• 목적: 작업 공간과 데이터 모델 구조를 관리합니다.
• 사용 사례:
  • 객체 및 필드를 생성, 수정 또는 삭제합니다.
  • 작업 공간 설정을 구성합니다.
  • 데이터 모델 관계를 관리합니다.
• 접근 방법: REST 엔드포인트를 통해 사용할 수 있습니다.

​

2. REST 핵심 API

• 목적: 실제 데이터 기록을 관리합니다.
• 사용 사례:
  • 데이터 기록 생성, 읽기, 업데이트, 삭제
  • 특정 데이터를 쿼리합니다.
  • 데이터 기록의 관계를 관리합니다.
• 접근 방법: REST 엔드포인트를 통해 사용할 수 있습니다.

​

GraphQL API

​

3. GraphQL 메타데이터 API

• 목적: REST 메타데이터 API와 동일하지만 GraphQL의 이점을 제공합니다.
• 사용 사례: 동일한 작업 공간 및 데이터 모델 관리
• 추가 혜택:
  • 한 번의 요청으로 여러 메타데이터 유형을 쿼리합니다.
  • 정확한 필드 선택
  • 복잡한 쿼리에 대한 더 나은 성능

​

4. GraphQL 핵심 API

• 목적: REST 핵심 API와 동일하지만 GraphQL의 장점을 포함합니다.
• 사용 사례: 동일한 데이터 기록 관리
• 추가 혜택:
  • 배치 작업: 모든 작업에 대해 사용할 수 있습니다.
  • 업서트 작업: 한 번의 호출로 기록을 생성하거나 업데이트합니다.
  • 싱글 요청으로 관계 쿼리
  • 정확한 데이터 가져오기

​

배치 작업

​

REST 및 GraphQL 배치 지원

REST 및 GraphQL API는 대부분의 작업에 대해 배치 작업을 지원합니다:

• 배치 크기: 요청당 최대 60개의 기록
• 사용 가능한 작업: 여러 기록을 생성, 업데이트, 삭제
• 성능: 개별 API 호출보다 크게 빠릅니다.

​

GraphQL 전용 기능

• 배치 업서트: GraphQL API에서만 사용 가능
• 사용 위치: 복수의 객체 이름 사용 (예: CreateCompanies 대신 CreateCompany)
• 요구 사항: 이 때문에 단수와 복수 객체 이름이 달라야 합니다.

​

API 문서 접속

1. Go to Settings → API & Webhooks
2. API 키를 생성 (문서 접속을 위해 필요함)
3. 맞춤형 문서 및 플레이그라운드에 접근하세요.
4. 실제 데이터 모델로 API를 테스트하세요.

귀하의 문서는 맞춤형 객체, 필드 및 관계를 반영하기 때문에 작업 공간 고유합니다.

​

각 API를 언제 사용할지

​

메타데이터 API는 다음과 같이 사용할 때:

• 데이터 모델을 설정할 때
• 사용자 정의 객체 또는 필드를 생성할 때
• 작업 공간 설정을 구성할 때

​

핵심 API를 사용할 때:

• 일상적인 데이터 관리 (인물, 회사, 기회)
• 외부 시스템과 통합할 때
• 맞춤형 애플리케이션을 구축할 때
• 데이터 워크플로우를 자동화할 때

​

GraphQL을 선택할 때:

• 배치 작업이 필요할 때
• API 호출을 최소화하고자 할 때
• 업서트 기능이 필요할 때
• 복잡한 통합을 구축할 때

​

REST를 선택할 때:

• 더 간단한 API 구조를 선호할 때
• 기본 통합을 구축할 때
• 팀이 REST에 익숙할 때
• 간단한 CRUD 작업이 필요할 때

​

다음 단계

• API & Webhooks Setup: Learn how to create API keys and webhooks
• Custom Documentation: Access your personalized API docs via Settings → API & Webhooks