Phrase TMS API
    1. Phrase
    2. Phrase TMS
    3. Phrase TMS API

    Using APIs (TMS)

    컨텐츠는 영어 텍스트를 Phrase Language AI를 이용해 기계 번역한 것입니다.

    샘플 API 호출과 API 개만 사용하여 간단한 작업을 완료 방법에 대한 지침이 포함된 간단한 API 시나리오입니다. API를 통해 설정할 수 있는 옵션은 광범위합니다. 사용 가능한 모든 옵션에 대한 자세한 내용은 REST API 문서 각 섹션을 참조하십시오.

    이 시나리오 생성에는 Postman API 플랫폼이 사용되었습니다.

    이러한 예에서는 표준 요청 URL이 https://cloud.memsource.com(으)로 시작됩니다. 미국 데이터 센터의 조직에서 API가 사용되는 경우 요청 URL은 https: //us.cloud.memsource.com으로 시작해야 합니다.

    시나리오

    1. 인증  

      사용자 인증되었습니다(로그인 API 상응).

    2. 생성  

      간단한 프로젝트 생성, 업로드된 작업 및 이메일 알림 포함된 번역자 할당

    3. 번역 

      API 시나리오 밖에서 수행된 번역 작업(편집자 중 일부).

    4. API 기능 

      할당이 완료되면(번역자가 완료함으로 표시) 프로젝트의 상태가 완료됨으로 설정되고 완료된 문서가 프로젝트에서 다운로드됩니다.

    방법

    각 개별 REST API 호출에 적절한 방법이 나열되어 있습니다. 잘못된 방법(예를 들어 프로젝트 생성 호출에서 POST 대신 GET)을 사용하면 API 호출이 실패하게 됩니다.

    단계 1: 인증

    두 가지 인증 방법이 있습니다.

    1. 인증 API 호출:

      24시간 동안 유효한 인증 토큰 생성합니다. 토큰 다음 모든 API에 삽입해야 합니다. 토큰 사용자를 확인하고 프로필 내의 다른 기능을 수행할 수 있도록 허용합니다.

    2. oAuth 2.0:

      응용 프로그램 유효성 검사 허용 확인된 응용 프로그램은 계속 통신 중이며 추가 인증 필요하지 않습니다.

    이 시나리오에는 인증 API 호출이 사용됩니다. 생성된 토큰 다음 API 호출에 모두 필요한 것이며 예시 매개 변수에 나열되지 않습니다.

    필수 매개 변수로 인증하려면 로그인 API를 사용하십시오. 이러한 경우에는 사용자 이름 및 암호가 필요합니다.

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v3/auth/login

    • 초기 요청: 

      { "userName":"username", "password":"password"}

    • 응답 

      인증 토큰

    여러 TMS 조직의 구성원은 여러 계정에 대해 동일한 사용자 이름과 암호가 있습니다. 이러한 경우에는 사용자가 로그인하려는 조직을 지정하려면 userUid 를 요청 본문에 추가해야 합니다. 지정되지 않은 경우 사용자 지정된 사용자 이름과 암호와 연결된 기본 계정 로그인됩니다.

    단계 2: 프로젝트 생성, 가져오기 및 할당

    프로젝트 생성

    필수 매개 변수 명, sourceLang 및 targetLangs가 있는 프로젝트 생성에는 프로젝트 API 호출을 사용합니다.

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v3/projects

    • 단계 요청 

      { "name":"My project", "sourceLang":"en", "targetLangs":[ "de","fr" ]}

    • 응답 

      프로젝트 UID(예: KmtNyVlz1skQd2aMVEipp7)

    마지막 호출에서 프로젝트 UID와 함께 생성 프로젝트 템플릿 API 호출을 사용하여 프로젝트 템플릿을 생성할 수 있습니다.

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v1/projectTemplates

    • 단계 요청 

      {
  "project": {
    "uid": "string"
  },
  "name": "string",
  "importSettings": {
    "uid": "string"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

    • 응답 

      프로젝트 템플릿 UID(예: AmtNyVlz1skQd2aMVEipp8)

    프로젝트를 생성하는 가장 효율적인 방법은 프로젝트 템플릿 사용 것입니다. 마지막 호출에서 프로젝트 템플릿 UID를 사용하여 템플릿에서 프로젝트 생성을 사용하여 프로젝트 템플릿 설정에 따라 새 프로젝트를 생성합니다.

    {templateUid} 식은 얻은 프로젝트 템플릿 UID가 삽입된 요청 URL에서 자리 표시자로 작동합니다. 

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v2/projects/applyTemplate/oNQiljwTGHpd2l1nnQRiu4

    • 단계 요청 

      {
  "name": "string",
  "sourceLang": "string",
  "targetLangs": [
    "string"
  ],
  "workflowSteps": [
    {
      "id": "string"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "note": "string",
  "client": {
    "id": "string"
  },
  "businessUnit": {
    "id": "string"
  },
  "domain": {
    "id": "string"
  },
  "subDomain": {
    "id": "string"
  },
  "costCenter": {
    "id": "string"
  }
}{
  "project": {
    "uid": "string"
  },
  "name": "string",
  "importSettings": {
    "uid": "string"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

    • 응답 

      프로젝트 UID(예: BmtNyVlz1skQd2aMVEipp9)

    작업 생성

    마지막 호출에서 프로젝트 UID를 사용하면 생성 작업을 사용하여 새로 생성된 프로젝트에 새 작업을 직접 추가할 수 있습니다.

    {projectUid} 연산이 얻은 프로젝트 UID가 삽입된 요청 URL에서 자리 표시자로 작용합니다. 생성 작업 API 호출을 사용하면 요청의 헤더를 Phrase 요구 사항 일치 항목으로 변경해야 합니다(기타 호출에서 Postman이 요청에 적절한 헤더를 자동으로 추가).

    가져오는 모든 매개 변수를 사용자 지정 Memsource 헤더에 삽입해야 합니다.

    컨텐츠 설정 헤더에는 가져오기 요청을 올바르게 처리하기 위해 사전 정의된 형식으로 파일 이름을 포함해야 합니다.

    소스 파일을 가져오려면 본문으로 이동하여 이진을 선택하고 파일 선택 옵션이 나타납니다.

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs 

    • (헤더) 컨텐츠 배포 

      filename*=UTF-8''file.txt 

    • (헤더) Memsource 

      {"targetLangs":["de","fr"]} 

    • (헤더) 컨텐츠 유형 

      application/octet-stream

    • 응답 

      작업 UID(예: dOYgeXzAdAbj4xFjuEVZP2)

      비동기식 요청 UID

    생성 작업 호출에서 AsyncRequest UID와 함께 비동기식 요청 받기를 사용하여 작업이 성공적으로 생성되었는지 및 작업이 기능이 있는지 확인합니다.

    반환된 작업 UID는 프로젝트 각 워크플로 단계 고유합니다. 따라서 작업 워크플로 포함된 프로젝트 생성된 경우 응답으로 각 워크플로 단계 대한 고유한 작업 UID가 반환됩니다. 

    재사용 가능한 가져오기 설정은 생성 가져오기 설정 호출으로 구성할 수 있습니다. 생성 작업 호출에 사용할 수 있는 가져오기 설정 UID가 응답에 수신됩니다.

    작업에 할당자(생성 작업 호출에서 직접 할당되지 않으면)는 편집 작업 호출을 사용합니다.

    호출에 삽입된 공급자 ID 다음과 같은 두 가지 방법으로 얻을 수 있습니다.

    • Phrase 응용 프로그램에서 ID를 검색하려면 다음 단계를 수행하십시오. 

      1. 설정 Setup_gear.png페이지에서 관리 섹션으로 스크롤하여 사용자를 클릭하거나 사이드바에서 사용자를 클릭합니다.

        사용자 페이지가 열립니다.

      2. 사용자의 성을 클릭하고 브라우저에서 URL의 마지막 부분을 복사하십시오.

      3. 해당 사용자 ID 이 부분을 사용.

    • 사용 리스트 사용자 API 호출. 

      이 API 호출에는 특정 매개 변수가 필요하지 않으며 계정 모든 사용자 목록 반환됩니다. 응답에 사용자 이름과 ID가 모두 포함되어 있습니다.

      선택 매개 변수인 userName 를 문의에 추가하여 특정 사용자 이름의 사용자만 목록을 설정할 수 있습니다.

    할당된 사용자에게 알림

    그런 다음 작업 U ID를 사용해야 하는 이메일 템플릿 ID를 나타내는 이메일 템플릿 매개 변수와 함께 할당된 사용자 알림 호출에서 선택적 매개 변수로 사용할 수 있습니다. 이것은 리스트 이메일 템플릿 호출을 사용하여 얻을 수 있습니다.

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs/notifyAssigned

    • 응답 

      Empty ( 상태 204: 컨텐츠 없음) 

    번역가 phrase UI를 사용하는 것처럼 프로필 작업 시작할 때가 여기입니다. 작업 완료된 후 담당 PM 알림 전송되고 시나리오의 다음 부분이 시작됩니다. 콜백은 시나리오의 다음 부분을 자동으로 시작하기 위해 웹 후크를 통해 감지할 수 있지만 이 예는 해결되지 않습니다.

    단계 3: 번역된 파일(완료) 다운로드, 프로젝트 완료로 설정

    번역된 파일 다운로드

    이 시나리오는 번역가 할당을 완료한 경우(작업을 완료됨으로 표시) 작동하지만, 완성된 파일은 언제든지 다운로드할 수 있습니다. 작업이 완료됨 상태가 필요하지 않습니다.  

    번역된 파일을 다운로드 두 개의 API 호출이 필요합니다. 비동기식 요청 호출을 기반으로 대상 파일(비동기식) 다운로드 및 대상 파일 다운로드

    첫 번째 단계는 projectUid 및 jobUid 매개 변수로 다운로드 대상 파일(비동기)을 호출하는 것입니다. 여러 워크플로 단계가 있는 프로젝트에서 완성된 파일을 다운로드하는 경우, 완료된 파일을 다운로드하려는 특정 워크플로 단계(예: 수정 워크플로 단계)의 jobUid를 사용해야 합니다.

    • Phrase 응용 프로그램에서 특정 워크플로 단계에 대한 작업 UID를 가져오는 방법은 다음과 같습니다. 

      1. 프로젝트 열기.

      2. 작업표에서 완성된 파일을 다운로드 워크플로 단계 전환하십시오.

      3. 브라우저에서 / 작업 후에 URL의 고유한 부분을 복사합니다.

    • 사용 리스트 작업 API 호출. 

      이 끝점은 특정 프로젝트 내 작업 목록 반환합니다. workflowLevel 문의 매개 변수와 함께 호출을 사용합니다. 이 매개 변수는 반환된 작업이 속한 워크플로 단계 나타내는 0 기반의 매개 변수입니다. 지정되지 않은 경우 값이 기본적으로 1(첫 번째 워크플로 단계)으로 설정됩니다. 예를 들어, 수정 단계에서 작업을 가져야 하는 경우 문의 매개 변수(예: 2)에 해당 단계의 번호를 지정합니다.

    대상 파일 다운로드비동기식) 호출은 번역이 포함된 대상 파일을 생성하고 다운로드 위한 비동기식 요청을 시작합니다. 응답 내에서 대상 파일을 직접 제공하지 않지만 다음 호출에 필요한 asyncRequestId를 제공합니다. 

    • 방법 

      PUT

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/targetFile 

    • 응답 

      AsyncRequest ID

    응답에서 asyncRequestID와 함께 비동기 요청 받기를 사용하여 요청이 완료되었는지 확인하십시오. 비동기식 요청이 완료되면 비동기식 요청 호출을 기반으로 대상 파일 다운로드를 사용하여 대상 파일을 다운로드할 수 있습니다. asyncRequestId는 한 번만 사용할 수 있습니다. 다운로드가 시작되면 asyncRequestId가 추가 사용을 위해 유효하지 않습니다.

    • 방법 

      받기

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/downloadTargetFile/1291716982 

    • 응답 

      완료된 파일 자체로 이진 응답

    프로젝트를 완료됨으로 설정

    프로젝트 작업이 완료된 후 프로젝트를 완료하려면 필수 매개 변수 projectUid 및 상태와 함께 편집 프로젝트 상태 호출을 사용하여 전체 프로젝트의 상태를 완료됨으로 변경합니다. 이 변경 사항은 수동으로 수행되지만, 프로젝트 상태 자동화를 사용하는 경우 상태가 자동으로 변경됩니다. 또한 웹 후크를 기다리고 수신된 콜백을 기반으로 다른 작업을 시작할 수도 있습니다.

    • 방법 

      POST

    • 요청 URL 

      https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus 

    • 단계 요청 

      { "status": "COMPLETED"}

    • 응답 

      Empty ( 상태 204: 컨텐츠 없음)

    도움이 되었습니까?

    Sorry about that! In what way was it not helpful?

    The article didn’t address my problem.
    I couldn’t understand the article.
    The feature doesn’t do what I need.
    Other reason.

    Note that feedback is provided anonymously so we aren't able to reply to questions.
    If you'd like to ask a question, submit a request to our Support team.
    Thank you for your feedback.