API 호출 세트가 제공돼서 다음을 수행할 수 있어:
-
Phrase와 모든 서드파티 소프트웨어(번역 관리 도구, CMS 등)의 통합
-
번역가의 작업대 개발. CAT 편집기는 공개 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에 액세스할 수 없는 경우, 요청은 2, 4, 8, 16, 30분 후에 10번 재시도에 모두 실패할 때까지 반복돼.
콜백 URL은 성공으로 간주되려면 200 OK HTTP 상태 코드를 응답해야 해.