API 인증
API 요청을 인증하고 각 작업에 필요한 접근 권한을 부여하세요.
X-API-Key 헤더에 Lingo.dev API 키를 담아 보내세요. 이 섹션의 API 레퍼런스에서는 https://api.lingo.dev/v2를 기본 URL로 사용하세요.
GET /v2/organizations/YOUR_ORGANIZATION_ID/localization/jobs HTTP/1.1
Host: api.lingo.dev
X-API-Key: YOUR_API_KEYAPI 키에서 키를 생성하세요. 키는 서버의 환경 변수나 비밀 정보 관리 도구에 저장하세요. 저장소, 브라우저 번들, URL, 원본 문서에는 포함하지 마세요.
인증 정보 선택 #
개인 키에는 해당 사용자의 현재 멤버십과 권한이 적용됩니다. 조직 서비스 키는 조직에 속하며 사람의 개입 없이 실행되는 서비스에 적합합니다. 접근 범위는 역할과 리소스에 부여된 권한에 따라 결정됩니다. 명시적으로 부여한 권한의 범위가 더 좁더라도 역할을 통해 이미 부여된 접근 권한은 줄어들지 않습니다.
API는 로그인한 사용자의 세션 접근 토큰도 Authorization: Bearer <access-token>로 허용합니다. 검토자는 자신의 사용자 세션이나 개인 키로 검토 결정을 제출할 수 있습니다. 사람이 하는 검토의 결정은 누가 내렸는지 식별할 수 있어야 하므로 서비스 키로는 제출할 수 없습니다.
요청마다 인증 방식은 하나만 사용하세요. 헤더 이름은 대소문자를 구분하지 않습니다.
조직 및 엔진 선택 #
조직 범위의 경로에는 orgId가 포함됩니다. 사용자 또는 개인 키의 조직 식별자를 찾으려면 GET /v2/users/me/memberships를 조회하세요. 서비스 키를 사용하는 경우에는 해당 키가 속한 조직을 사용하세요. 엔진 식별자는 Studio에서 설정한 엔진을 식별합니다. 접근 가능한 엔진 목록은 GET /v2/organizations/:orgId/engines로 조회하세요.
현지화 작업을 생성, 시작, 조회하거나 다운로드하려면 해당 조직에 대한 접근 권한과 해당 엔진의 번역 권한이 필요합니다. 프로비저닝하려면 엔진을 편집하거나 생성할 권한과 요청한 지침을 생성할 권한이 필요합니다. 번역 검토에는 검토자의 권한 및 라우팅이 적용됩니다.
조직이나 엔진 식별자를 전달하는 것만으로는 접근 권한이 부여되지 않습니다. 호출자의 접근 범위를 벗어난 리소스는 404를 반환할 수 있습니다. 존재하는 리소스를 찾을 수 없다면 식별자와 호출자의 권한을 모두 확인하세요.
접근 실패 진단 #
HTTP 상태와 함께 문제 응답도 확인하세요. 401은 인증 정보가 없거나 유효하지 않거나 만료되었음을 나타냅니다. 402는 역할 기반 접근 제어 등급 하향으로 서비스 키가 비활성화된 경우를 비롯해 청구 또는 요금제 관련 조건을 나타냅니다. 403은 권한이 거부되었거나 사용자 신원 확인이 필요함을 나타냅니다. 엔진 설정과 계정 한도 문제는 각각 별도로 해결해야 합니다.
진단을 위해 문제 type, 상태, 비밀 정보에 해당하지 않는 리소스 식별자를 보관하세요. 인증 헤더는 절대 로그에 기록하지 마세요.
키 교체 #
새 키를 생성하고 필요한 접근 권한을 부여한 다음 서비스의 비밀 정보를 업데이트하세요. 기존 키를 폐기하기 전에 새 키로 기존 작업을 조회하고 결과를 다운로드할 수 있는지 확인하세요. 기록해 둔 작업 식별자는 보관하세요. 인증 정보를 교체해도 작업 식별자는 바뀌지 않습니다.