API 접근 및 인증

SPREEAI은 승인된 파트너 워크플로에 대한 공개 API 참조를 제공합니다. https://docs.spreeai.com/swagger/public/.

접근 모델

API 범위, 환경, 자격 증명 및 허용되는 작업은 파트너 온보딩 과정에서 합의됩니다. 내부, 개발 또는 과거 사용 이력이 있는 엔드포인트가 프로덕션 환경에서 사용 가능하다고 가정하지 마십시오.

자격 증명 규칙

• 클라이언트 비밀 키와 액세스 토큰은 안전한 서버 측 비밀 키 저장소에만 저장하십시오.
• 절대로 자격 증명을 Git, 문서, 이슈 트래커, 스크린샷 또는 샘플 애플리케이션에 커밋하지 마십시오.
• 분석 또는 로깅 플랫폼에 자격 증명을 절대 보내지 마십시오.
• 환경별 자격 증명은 해당 자격 증명이 발급된 환경에서만 사용하십시오.
• 자격 증명이 노출된 경우 즉시 교체하십시오.
• 지원 요청에서 인증 헤더와 토큰을 삭제합니다.

브라우저 vs 서버

웹 SDK는 파트너가 제공한 브라우저 구성을 사용합니다. 클라이언트 비밀 키는 브라우저에 포함되어서는 안 됩니다.

서버 측 통합은 현재 승인된 API 참조에 있는 인증 흐름 및 엔드포인트 정의를 따라야 합니다. 필요한 작업이 없는 경우, 문서화되지 않은 경로를 구축하는 대신 파트너 엔지니어링을 통해 요청하십시오.

웹훅

서버 푸시 웹훅은 현재 게시된 웹 SDK 문서에 포함되어 있지 않습니다. 웹훅에 대한 의존성을 설계하기 전에 웹훅 요구 사항을 확인하십시오.

환경 체크리스트

• [ ] 환경 이름이 문서화되었습니다.
• [ ] 기본 URL은 승인된 참조 또는 온보딩 인계에서 가져왔습니다.
• [ ] 해당 환경에 대한 자격 증명이 발급되었습니다.
• [ ] 비밀 정보는 서버 측에 저장됩니다.
• [ ] 로그에서 토큰과 고객 이미지를 삭제합니다.
• [ ] 쓰기 작업에 대한 타임아웃, 재시도 및 멱등성 동작이 합의되었습니다.
• [ ] 프로덕션 액세스가 사용되기 전에 비프로덕션 테스트가 성공해야 합니다.