Интерфейс приложений API Phrase TMS

интерфейс приложений API Technology ((TMS))

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

Наш интерфейс приложений API рассматривает сущности приложений (проекты, задания, Настройки) как ресурсы, которые можно извлечь, создатьо, изменено и удалить. 

Каждый метод HTTP означает действие:

  • GET

    Получение ресурса без изменения ресурса

  • POST

    Создать ресурс. разместить пост также Использование для операций, которые не укладываются ни в одну из четырех операций или имеют длительный или сложный ввод — например, Поиск в памяти Перевод или создание задание.

  • PUT

    Обновить ресурс. Обратите внимание, что вся сущность обязательна для заполнения со всеми полями, а не только с теми, которые были изменены; не включая ее, она должна быть установлена На нуль.

  • УДАЛИТЬ

    Удалён (Del) ресурс.

Импорт

Входные и выходные данные обычно имеют Форму JSON, закодирован UTF-8. Для файла в качестве запроса Тип контента приложения/октета-потока или Использования многочастей/Форм.

Использование сущностей плоской структуры На поддержание хорошего времени реагирования. Вместо того, чтобы включать в ответы целые дочерние объекты, содержатся ссылка, содержащие идентификатор, Уникальный идентификационный номер (Uid) и некоторые другие приписать. Ожидается использование либо IDReference, либо объектов UidReferencee На ссылки На связанные субъекты.

Все Списки ответов находятся на странице. Использование страницы Параметры и Размер страницы На получения запрошенных данных. Максимальный размер страницы - 50.

Документация

Использование OpenAPI 3.0 для интерфейса приложений API. Для разработки клиентов рекомендуется использовать генераторы отвязного кода.

Файлы исходной документации:

API примеры

Получить Список всех баз памяти Переводов

GET

/web/api2/v1/transMemories

Ответ

200

{
    "pageNumber": 0,
    "контент": [
        {
            "internalId": 1,
            "создать": {
                "Использование": "Администратор",
                "идентификатор": "3",
                "firstName": Январь,
                "lastName": "Яноко",
                "роль": "АДМИНИСТРАТОР",
                "email": "jan.janocko@phrase.com"
            },
            «клиент»: нулевой,
            "Примечание": "не требуется На Использование в Памяти переводов",
            "DateCreated": "2018-01-09T14:07:46+0000",
            "идентификатор": "1",
            "targetLangs": [
                "es",
                "это"
            ],
            "специализация": null,
            "businessUnit": {
                "идентификатор": "1",
                «имя»: "Первый BU"
            },
            "sourceLang": "en",
            "отрасль": нулевая,
            «имя»: Моя новая Память переводов
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Создать новую память переводов

POST

/web/api2/v1/transMemories

{{
«имя»: Моя новая Память переводов
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"идентификатор": "1"
},
"Примечание": "Отсутствует необходимость На Использовании в Памяти переводов"
}

Ответ

201

{
    "internalId": 1,
    "создать": {
        "Использование": "Администратор",
        "идентификатор": "3",
        "firstName": "J",
        "lastName": Январь,
        "роль": "АДМИНИСТРАТОР",
        "Электронная почта": "jan.j@phrase.com"
    },
    «клиент»: нулевой,
    "Примечание": "не требуется На Использование в Памяти переводов",
    "DateCreated": "2018-01-09T14:07:46+0000",
    "идентификатор": "1",
    "targetLangs": [
        "es",
        "это"
    ],
    "специализация": null,
    "businessUnit": {
        "идентификатор": "1",
        «имя»: "Первый BU"
    },
    "sourceLang": "en",
    "отрасль": нулевая,
    «имя»: Моя новая Память переводов
}

Добавить файлы при создании задания

Добавить этот файл На Текст сообщения в виде двойного Приложения. Убедитесь, что Phrase и заголовки контент корректно вставить.

Пример PHP для размещенного поста:

<?php

$request = новый HttpRequest();
$request->setUrl('https://cloud.phrase.com/web/интерфейс приложений API2/v1/projects/%7BUID%20of%20your%20project%7D/задания);
$request->setMethod(HTTP_METH_POST);

$request->setQueryData(array(
токен => «Ваш токен идет здесь»
));

$request->setHeaders(array(
'postman-token' => 'ABC',
'cache-control' => 'no-cache',
'контент-disposition' => 'имя файла-8'''Sample.txt',
'msource' => '{\\"targetLangs\\":[\\"de\",\\"fr\",\\"es\"],\\"callbackUrl\\":\"https://my-shiny-услуга.com/consumeCallback\\",\\"importSettings\\":{\\"uid\\":\"WF0T1SfSHxII09yKr0dZh9\"}'
));

попробовать {
$ответ = $запрос->отправить();

echo $response->getBody();
} Автоматизированный перевод (CAT) (HttpException $ex) {
эхо $ex;
}

Обработка ошибок

При возникновении проблем с обработкой запроса на интерфейс приложений API происходит возврат следующей структуры JSON. Код ошибки будет присутствовать всегда; подробное описание может быть равным нулю.

{ "errorCode": "Недействительные аргументы",
"errorDescription": «Пропущен требуемый аргумент \"пароль\" Типа \"строка\"».
}

Реакция на ошибку может быть обнаружена при чтении ответа со статусом HTTP. При возникновении ошибки никогда не будет установлено значение На 2хх. Код статуса — 400 неудачных запросов, 401 или 403 — в связи с проблемами Аутентификации или авторизации.

Проблемы отчетности

Сообщая На техническую поддержку, включает в отчет следующее:

  • Конечная точка интерфейс приложений API

  • Запрос

  • Часовой (и часовой пояс)

  • Ответ

  • Phrase-Action-идентификатор ответа

Была ли эта статья полезной?

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.