번역 작업 조회
문서별 번역 대상을 확인하고, 완료를 기다린 뒤 준비된 결과물을 다운로드합니다.
생성 시 반환된 id을 사용해 작업을 조회합니다:
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEY응답에는 모든 문서와 각 문서의 대상 로캘 정보가 포함됩니다. 일부 대상이 아직 처리 중이거나 실패한 상태여도 완료된 대상이 포함될 수 있습니다.
작업 필드 #
| 필드 | 의미 |
|---|---|
id, organizationId, engineId | 작업 식별 정보, 소유 조직, 엔진. |
sourceLocale | 원본 언어. |
trigger | api, cli, ci 또는 연동 등의 출처. |
status | 태그로 구분되는 작업 상태. 아래에서 설명합니다. |
createdAt, updatedAt | ISO 형식의 타임스탬프 문자열. |
createdBy | 생성자 정보. 확인할 수 없으면 null입니다. 개인 키로 생성한 작업은 해당 키의 사용자에게 귀속됩니다. |
documents | 문서, 각 문서의 형식과 원본 주소, 대상별 진행 상황. |
uploads | 대기 중인 작업에 필요한 누락된 아티팩트의 주소와 업로드 주소. 작업이 시작되면 비어 있습니다. |
작업 상태 #
status._tag | 수행할 작업 |
|---|---|
Pending | 누락된 아티팩트를 업로드하고 /start을 호출합니다. |
Running | 잠시 후 다시 폴링합니다. 대상별 단계를 살펴 처리 중인지 검토 대기 중인지 확인합니다. |
Completed | 결과물을 다운로드해 확인합니다. 결과물의 수용 여부를 판단할 때 단계별 경고도 확인합니다. |
Failed | status.message과 대상별 실패 정보를 확인합니다. 완료된 대상은 계속 사용할 수 있습니다. |
Cancelled | 처리가 중단되었습니다. 대상별로 이미 완료된 결과물이 있는지 확인합니다. |
Completed, Failed, Cancelled은 작업의 최종 상태입니다. 부분 실패란 완료된 대상과 실패한 대상이 함께 있는 실패한 작업을 뜻합니다.
문서 및 대상 필드 #
각 문서에는 id, key, format, source, previousSource, targets이 포함됩니다. 요청에서 인라인 제이슨 데이터를 제공했더라도 source은 아티팩트 주소입니다. previousSource이 없으면 null입니다.
각 대상에는 다음이 포함됩니다:
| 필드 | 의미 |
|---|---|
locale | 대상 언어. |
previousTranslation | 이전 대상 아티팩트 주소 또는 null. |
status | _tag 필드의 값은 Pending, Completed 또는 Failed입니다. |
stages | 상태와 단위 수를 포함한 단계별 진행 상황. |
완료된 대상의 상태에는 artifact과 downloadUrl가 포함되고, 실패한 대상의 상태에는 message이 포함됩니다. 다음은 완료된 대상의 상태를 보여 주는 응답 일부입니다:
{
"_tag": "Completed",
"artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}실제로 반환된 주소와 다운로드 주소를 사용하세요. 다운로드 주소는 https://api.lingo.dev을 기준으로 한 상대 주소이며 인증이 필요합니다. 공개적으로 접근할 수 있는 서명된 다운로드 링크가 아닙니다. 다운로드하면 해당 문서 형식의 파일 바이트가 반환됩니다.
여러 대상이 하나의 아티팩트를 공유할 수 있습니다. 애플 문자열 카탈로그는 요청된 언어를 하나의 .xcstrings 파일로 통합합니다. 다운로드할 때마다 별도의 단일 언어 카탈로그로 취급하지 말고, 통합된 결과물을 한 번만 저장한 뒤 그 안의 로캘 항목을 확인하세요.
폴링 및 결과물 수집 #
애플리케이션의 대기 제한 시간을 정하고, 2초마다 한 번처럼 정해진 간격으로 작업을 폴링하세요. 조회가 일시적으로 실패하면 식별자를 유지하고 대기 시간을 점차 늘려 재시도하세요. 대기를 종료해도 서버 처리는 취소되지 않습니다. 사람이 하는 검토는 애플리케이션 요청에 설정된 짧은 제한 시간보다 훨씬 오래 걸릴 수 있습니다.
대상의 상태가 Completed이 되면 다운로드하세요. 애플리케이션에서 모든 언어를 함께 게시해야 한다면 필요한 모든 대상이 완료될 때까지 기다린 뒤 자체 저장소에서 해당 게시 규칙을 적용하세요. 파일 하나가 완료되었다고 해서 모든 로캘이 성공한 것은 아닙니다.
폴링과 다운로드를 수행하는 전체 프로그램은 빠른 시작을 참고하세요. 원본 리비전 처리와 재시도 여부 판단은 번역 워크플로 구축을 참고하세요.