메타데이터를 사용하면 Dodo Payments의 객체에 대한 추가적인 구조화된 정보를 저장할 수 있습니다. 결제, 구독 등 대부분의 Dodo Payments 객체에 메타데이터를 첨부할 수 있습니다.
- 메타데이터 키는 최대 40자까지 가능합니다.
- 메타데이터 값은 문자열, 숫자 또는 불리언일 수 있으며, 문자열은 최대 500자까지 가능합니다.
- 객체, 배열 및
null는 메타데이터 값으로 허용되지 않습니다.
- 객체당 최대 50개의 메타데이터 키-값 쌍을 사용할 수 있습니다.
- 키는 영숫자, 대시, 밑줄만 포함해야 합니다.
- 메타데이터는 API를 통해 검색할 수 없지만, API 응답과 웹훅에 반환됩니다.
사용 사례
메타데이터는 다음과 같은 용도로 유용합니다:
- 외부 ID 또는 참조 저장
- 내부 주석 추가
- Dodo Payments 객체를 시스템에 연결
- 거래 분류
- 보고를 위한 사용자 정의 속성 추가
메타데이터 추가
API를 통해 객체를 생성하거나 업데이트할 때 메타데이터를 추가할 수 있습니다. 제품의 경우 대시보드 UI에서 직접 메타데이터를 추가할 수도 있습니다.
API를 통한 추가
대시보드 UI를 통한 추가 (제품 전용)
제품의 경우 Dodo Payments 대시보드에서 제품을 생성하거나 편집할 때 메타데이터를 직접 추가할 수 있습니다. 메타데이터 섹션을 통해 코드를 작성하지 않고도 사용자 정의 키-값 쌍을 쉽게 추가할 수 있습니다.
제품 메타데이터를 위한 대시보드 UI 사용은 제품 정보와 카테고리를 관리해야 하는 비기술 팀 구성원에게 특히 유용합니다.
메타데이터 검색
메타데이터는 객체를 검색할 때 API 응답에 포함됩니다:
검색 및 필터링
메타데이터는 API를 통해 직접 검색할 수 없지만 다음과 같은 방법을 사용할 수 있습니다:
- 메타데이터에 중요한 식별자를 저장
- 기본 ID를 사용하여 객체 검색
- 애플리케이션 코드에서 결과 필터링
모범 사례
Do:
- 메타데이터 키에 대해 일관된 명명 규칙을 사용하십시오
- 메타데이터 스키마를 내부적으로 문서화하십시오
- 값을 짧고 의미 있게 유지하십시오
- 메타데이터는 정적 데이터에만 사용하십시오
- 서로 다른 시스템에 대해 접두사를 사용하는 것을 고려하십시오(예:
crm_id, inventory_sku)
하지 말아야 할 일:
- 메타데이터에 민감한 데이터 저장
- 자주 변경되는 값에 메타데이터 사용
- 중요한 비즈니스 로직에 메타데이터 의존
- 객체의 다른 곳에서 사용할 수 있는 중복 정보 저장
- 메타데이터 키에 특수 문자 사용
지원되는 객체
메타데이터는 다음 객체에서 지원됩니다:
웹훅 및 메타데이터
메타데이터는 웹훅 이벤트에 포함되어 사용자 정의 데이터로 알림을 쉽게 처리할 수 있습니다: