API 호출 세트가 제공되어 다음을 허용합니다:
-
Phrase와 모든 제3자 소프트웨어(번역 관리 도구, 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 상태 코드를 응답해야 합니다.