API
서버에서 JSON과 파일을 번역하고, 진행 상황을 추적하며, 완료된 번역을 다운로드하세요.
Lingo.dev API로 애플리케이션이 소유한 콘텐츠를 번역하세요. 현지화 작업은 엔진, 원본 언어, 대상 언어, 하나 이상의 문서로 구성됩니다. 각 문서는 요청한 언어별 번역 대상을 추적합니다. 대부분의 형식은 언어별로 별도의 대상 파일을 생성하지만, 애플 문자열 카탈로그는 여러 언어를 하나의 파일에 담습니다.
API 기본 URL은 https://api.lingo.dev/v2입니다. API 인증 정보는 서버에 보관하세요. 첫 번역 요청으로 메시지 두 개를 번역하고 결과를 저장해 보세요.
입력 방식 선택 #
| 번역할 콘텐츠 | 시작 방법 |
|---|---|
| 애플리케이션이 이미 보유한 JSON 객체 | JSON 번역. 생성 요청에 객체를 직접 담아 보내세요. |
| JSON, 마크다운, HTML, 모바일 리소스 등의 파일 | 문서 번역. 원본 바이트를 업로드하고 동일한 형식의 파일을 다운로드하세요. |
| 여러 문서 또는 대상 언어 | 번역 작업 생성. 하나의 작업에 인라인 JSON과 업로드한 파일을 함께 포함할 수 있습니다. |
세 가지 방식 모두 다음과 같은 순서로 진행됩니다.
- 작업을 생성하고 작업 ID를 원본 리비전과 함께 저장하세요.
- 응답의
uploads배열에 나열된 모든 아티팩트를 업로드하세요. 인라인 JSON 원본은 작업 생성 시 저장됩니다. - 작업을 시작하세요.
- 필요한 문서의 번역 대상이 모두 완료될 때까지 진행 상황을 확인하세요.
- 완료된 각 번역 대상을 해당
status.downloadUrl에서 다운로드하세요.
생성 단계에서는 수행할 작업을 저장하고, 시작 단계에서는 작업을 접수해 처리를 시작합니다. 생성 요청이 성공했다고 해서 번역 결과가 반환되는 것은 아닙니다.
재사용 범위와 예상 비용을 확인하려면 작업을 생성하기 전에 작업량을 추산하세요.
번역 설정 #
engineId로 사용할 엔진을 명시적으로 선택하세요. 엔진은 모델, 용어집, 규칙, 브랜드 보이스와 함께 번역 파이프라인을 제공합니다. API 키에는 해당 엔진을 사용해 번역할 수 있는 권한이 있어야 합니다.
JSON에는 format.options를 통해 문서별 맥락, 힌트, 보호할 경로를 추가하세요. 이후 리비전에서는 이전 원본과 번역을 제공해 변경되지 않은 콘텐츠를 재사용하세요.
휴먼 리뷰를 사용하면 권한이 있는 검토자가 파이프라인의 다음 단계로 넘어가기 전에 검토 대상 번역을 승인하거나 수정할 수 있습니다. 검토 워크플로 가이드에서 제출, 검토, 전달 단계를 연결하는 방법을 확인하세요.
작업과 함께 애플리케이션 상태 유지 #
다음 단계로 넘어가기 전에 작업 ID, 원본 리비전, 문서 키, 요청한 로캘을 영구 저장하세요. 작업 생성 시 Idempotency-Key 헤더를 사용하면 응답이 불확실해도 새 작업을 만들지 않고 재시도할 수 있습니다. 대체 작업을 제출하기 전에 기존 작업을 조회하세요.
다른 번역 대상이 실패하더라도 완료된 번역 대상은 다운로드하세요. 결과가 여전히 애플리케이션에서 예상하는 원본 리비전에 해당할 때만 게시하세요. 번역 워크플로 구축에서 이러한 조정 방법을 다룹니다.
접근과 복구에 관한 내용은 인증, 오류, 오류 목록을 참고하세요.
엔진 준비 및 개선 #
프로비저닝은 웹사이트 콘텐츠나 텍스트를 바탕으로 용어집, 규칙, 브랜드 보이스를 채웁니다. 엔진 제안은 피드백을 바탕으로 직접 살펴보고 적용할 수 있는 제안을 만듭니다. 생성된 지침은 번역에 활용하기 전에 검토하세요.