다음과 같은 API 호출 세트를 사용할 수 있습니다:
-
Phrase와 타사 소프트웨어(번역 관리 도구, CMS 등)의 통합
-
번역가용 워크벤치 개발. CAT Editor은(는) 공용 API를 기반으로 구축되었습니다.
-
백엔드에서 Phrase를 사용하는 새로운 도구 또는 서비스 생성.
기본 워크플로
API를 사용하기 전에 절차와 워크플로를 이해해야 합니다. 관련 API를 구현하기 전에 Phrase의 절차를 숙지하는 것이 좋습니다.
기본 워크플로는 다음과 같습니다:
비동기 API
비동기 API는 항상 동기식 API보다 우선적으로 사용해야 합니다. 동기식 API를 호출하는 경우 대량의 파일 배치나 단일 대용량 파일을 처리할 때 시간 초과 응답을 받을 가능성이 있습니다. 동기식 API는 소규모 파일 및 소규모 통합에만 사용해야 합니다.
폴링
비동기 API를 호출한 후, 식별자 요청을 포함한 즉각적인 응답을 받습니다. 이 식별자를 사용하여 getAsyncRequest을 호출하고 asyncResponse 필드를 확인하여 요청의 상태를 확인하십시오. 이 폴링 방식은 null이 아닌 asyncResponse을 받기 전에 여러 번의 getAsyncRequest 호출로 이어질 수 있습니다.
콜백
비동기 요청에 대한 폴링 방식의 단점에 대한 대응으로, 모든 비동기 API에서 콜백에 대한 지원이 제공됩니다. 비동기 요청을 호출할 때, 비동기 요청에 의해 시작된 작업이 완료된 후 요청되는 URL을 (callbackUrl 매개변수에) 지정하십시오.
콜백은 HTTP POST 호출을 통해 요청되며 데이터는 JSON으로 인코딩된 본문에 전달됩니다. JSON 객체에는 항상 다음이 포함됩니다:
-
비동기 요청에 대한 정보(getAsyncRequest를 호출할 때와 동일).
-
전체 분석 또는 작업 세부 정보와 같은 작업 결과에 대한 자세한 정보입니다.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
콜백 URL에 액세스할 수 없는 경우, 10번의 재시도에 실패할 때까지 2, 4, 8, 16, 30분 후에 요청이 반복됩니다.
콜백 URL은 성공으로 간주되려면 200 OK HTTP 상태 코드로 응답해야 합니다.