콘텐츠로 건너뛰기

브랜딩

Management API에서 제공하는 7개의 조직 브랜딩 필드를 관리합니다. Hosted Auth 런타임 적용 및 사용자 지정 CSS는 제공되지 않습니다.

Markdown으로 보기

브랜딩 옵션

Management API는 조직 범위의 브랜딩 값 7개를 KV에 저장합니다. 인증된 관리 클라이언트에서 사용할 수 있지만 Hosted Auth와 이메일에 자동으로 적용하는 기능은 구현되지 않았습니다.

옵션 설명
기본 색상 관리 클라이언트의 기본 색상 값이 저장되어 있습니다.
배경 색상 관리 클라이언트에 대해 저장된 페이지 배경 값입니다.
강조 색상 관리 클라이언트를 위한 저장된 강조 색상 값입니다.
테두리 반경 저장된 border-radius 값입니다. API는 이를 특정 명명 스케일로 제한하지 않습니다.
글꼴 패밀리 저장된 글꼴 모음 값입니다. API는 원격 글꼴을 가져오거나 유효성을 검사하지 않습니다.
로고 (라이트) 저장된 밝은 테마 로고 URL입니다. 조직 로고 업로드는 별도의 R2 지원 엔드포인트입니다.
로고 (다크) 저장된 어두운 테마 로고 URL. 이 API는 자동 대체를 적용하지 않습니다.

조직별 브랜딩

각 레코드는 KV의 테넌트 및 조직별로 입력됩니다. 레코드가 없으면 읽기는 null 값이 있는 7개 필드를 모두 반환합니다. 런타임 렌더링이나 대기 시간 보장은 암시되지 않습니다.

관리 API 엔드포인트

CamelCase 필드 이름을 사용하여 PATCH 요청으로 조직 브랜드를 업데이트합니다. 생략된 필드와 null은 현재 저장된 값을 유지합니다. 필드를 변경하려면 대체 문자열을 보냅니다.

curl -X PATCH https://xid.dev/v1/organizations/org_xxx/branding \
  -H 'Authorization: Bearer sk_live_xxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryColor": "#6366f1",
    "borderRadius": "0.5rem",
    "fontFamily": "Inter, sans-serif",
    "logoUrl": "https://cdn.example.com/logo.svg"
  }'

검증 경계

  • 브랜딩 스키마는 위에 나열된 7개 필드만 허용합니다. 사용자 정의 CSS는 허용되지 않습니다.
  • 엔드포인트가 스타일시트를 허용하지 않으므로 @importurl() CSS 처리는 구현되지 않았습니다.
  • 값은 문자열로 저장됩니다. 색상, 반경, 글꼴 및 URL 구문은 JSON 유형 이상으로 검증되지 않습니다.
  • iframe 미리보기나 별도의 초안 및 게시 상태가 없습니다.

이메일 템플릿 경계

트랜잭션 이메일은 기본 제공 Mustache 템플릿과 전역 R2 로케일 팩을 사용합니다. 조직별 HTML 템플릿 업로드 및 브랜딩 자동 삽입은 구현되지 않았습니다.

탐색

입력하여 검색...

화살표 키로 이동Enter 키로 선택Escape 키로 닫기