인증 및 API 키
키 생성
섹션 제목: “키 생성”API 센터 에서 sk_ API 키를 생성하십시오. 전체 키는 생성되거나 교체될 때에만 한 번 표시됩니다.
각 애플리케이션, 환경 및 자동화 작업마다 별도의 키를 사용하여 각 키에 대해 고유한 예산을 설정하고, 개별적으로 비활성화, 휠링 및 감사를 수행할 수 있도록 합니다.
자격 증명을 전송하세요
섹션 제목: “자격 증명을 전송하세요”권장 사항:
X-API-Key: sk_your_key표준 Bearer 형식도 작동합니다:
Authorization: Bearer sk_your_key요청 시 두 가지 중 하나만 전송하십시오.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"키가 나타내는 것
섹션 제목: “키가 나타내는 것”키는 해당 계정에 대해 작동하며, 해당 계정이 사용할 수 있는 서비스를 호출하고 해당 계정의 리소스에만 접근할 수 있습니다. 키는 로그인 이메일, 비밀번호, 전화번호 또는 프로필을 변경할 수 없으며, API 키를 생성하거나 교체하거나 취소할 수도 없습니다.
선택적 한계:
allowed_engines: 나열된 번역 설정만 적용되며, 빈 배열은 키 수준 제한을 추가하지 않습니다.expires_at: 만료 시간.quota_limit: 키의 수명 예산은 전체 밀리크레딧 단위로 표시됩니다;0에서는 키 수준의 예산이 설정되지 않으며, 계정의 크레딧은 일반 방식으로 정산됩니다.
회전 및 취소
섹션 제목: “회전 및 취소”API 센터에서 키를 생성하고, 한계를 변경하며, 회전시키거나 취소할 수 있습니다. 키가 취소되거나 비활성화되거나 만료되었거나 해당 계정이 비활성화되면, 이후의 요청은 즉시 실패합니다.
회전은 새로운 비밀 키를 생성하고 기존 키를 즉시 비활성화합니다. 새 키는 원래의 제한 사항과 이미 사용된 예산을 그대로 유지합니다. 만료된 키는 회전할 수 없으므로 새 키를 생성해야 합니다. 원활한 전환을 위해 새 키를 생성하여 배포한 뒤, 호출이 성공하는지 확인한 다음 기존 키를 취소하십시오.
- 키는 서버 또는 관리되는 런타임 환경에만 저장하십시오.
- 환경 변수나 시크릿 관리자를 사용하고, 키를 소스 코드, 로그, 브라우저 번들 또는 공개 저장소에 절대 포함하지 마십시오.
- API에서 반환된 업로드 또는 다운로드 주소에 키를 절대 전송하지 마십시오.
- 키 ID, 요청 ID 및 작업 ID를 로그에 기록하되, 전체 키는 절대로 로그에 기록하지 마십시오.
- 키가 유출된 경우 즉시 키를 교체하고 해당 키의 작업 및 권한을 검토하십시오.