Phrase TMS API

Tecnología API (TMS)

El contenido se traduce automáticamente del inglés por Phrase Language AI.

Nuestra API ve las entidades de aplicación (proyectos, trabajos, Configuración) como recursos que pueden ser recuperados, creados, modificados y eliminados. 

Cada método HTTP representa una acción:

  • GET

    Recupera un recurso, sin cambiar nunca el recurso

  • POST

    Crea un recurso. posterior también se Usar para operaciones que no encajan en ninguna de las cuatro operaciones o que tienen una entrada larga o compleja, como la Buscar en memorias de traducción o la creación de trabajo.

  • PUT

    Actualiza el recurso. Tenga en nota que toda la entidad es necesaria con todos sus campos, no solo los modificados; no incluirlo significa que debe establecerse Para nulo.

  • DELETE

    Elimina el recurso.

Importa

Los datos de entrada y salida suelen estar en Formulario JSON, codificados UTF-8. Para un archivo como Cuerpo solicitante se Usa contenido Tipo aplicación/flujo de octetos o datos múltiples/ Formulario.

Las entidades Usan una estructura plana cuando es posible Para mantener buenos tiempos de respuesta. En lugar de incluir objetos hijo completos en las respuestas, se contienen referencias que contienen el id, Uid y algunos otros atributos. Se esperan objetos IDReference o UidReference Para referirse Para entidades relacionadas.

Todas Listas de respuestas están paginadas. Usa los Parámetros pageNumber y pageSize Para recuperar los datos solicitados. El tamaño máximo de página es 50.

Documentación

OpenAPI 3.0 se Usa para la documentación API. Se recomiendan generadores de códigos de presunción para el desarrollo de clientes.

Archivos de documentación pura:

Ejemplos API

Obtener Lista de todas memorias de traducción

GET

/web/api2/v1/transMemories

Respuesta

200

{
    "pageNumber": 0,
    "content": [
        {
            "internalId": 1,
            "createdBy": {
                "userName": "admin",
                "id": "3",
                "firstName": "Jan",
                "lastName": "Janocko",
                "función": "ADMIN",
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            "nota": "no es necesario Para Usar en TM",
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                "es",
                "it"
            ],
            "subDomain": null,
            "businessUnit": {
                "id": "1",
                "nombre": "Primero BU"
            },
            "sourceLang": "en",
            "domain": null,
            "nombre": "Mi nueva TM"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Crear una nueva memoria de traducción

POST

/web/api2/v1/transMemories

{{
"nombre": "Mi nueva TM",
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"nota": "no es necesario Para Usar en TM"
}

Respuesta

201

{
    "internalId": 1,
    "createdBy": {
        "userName": "admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "función": "ADMIN",
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "nota": "no es necesario Para Usar en TM",
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        "es",
        "it"
    ],
    "subDomain": null,
    "businessUnit": {
        "id": "1",
        "nombre": "Primero BU"
    },
    "sourceLang": "en",
    "domain": null,
    "nombre": "Mi nueva TM"
}

Agregar archivos al crear un trabajo

Agregar este archivo Para el Cuerpo de la solicitud como Anexo binario. Asegúrese de que Phrase y los encabezados de disposición de contenido se insertan correctamente.

Muestra PHP del posterior:

<?php

$request = new HttpRequest();
$request->setUrl('https://cloud.phrase.com/web/ API2/v1/projects/%7BUID%20of%20your%20project%7D/trabajos');
$request->setMethod(HTTP_METH_POST);

$request->setQueryData(array(
Identificador único (token) => 'Su identificador único (token) va aquí'
));

$request->setHeaders(array(
'postman-token' => 'ABC',
'cache-control' => 'no-cache',
'content-disposition' => 'filename*=UTF-8''Sample.txt',
'Memsource' => '{\\"targetLangs\\":[\\"de\\",\\"fr\\",\\"es\\"],\\"callbackUrl\\":\\"https://my-shiny- service.com/consumeCallback\\",\\"importSettings\\":{\\"uid\\":\\"WF0T1SfSHxII09yKr0dZh9\\"}}'
));

probar {
$response = $request->send();

echo $response->getBody();
} CAT (HttpException $ex) {
echo $ex;
}

Error manejo

Si hay un problema de manejo de una solicitud API, se regresará la siguiente estructura JSON. El código de error siempre estará presente; la descripción detallada puede ser nula.

{ "errorCode": "InvalidArguments",
"errorDescription": Faltante "argumento requerido \"contraseña\" de Tipo \"cadena\".
}

Puede detectarse un error leyendo el código de error estado HTTP de la respuesta. Si se produce un error, nunca se cambiará Para 2xx. El código de estado es 400 solicitud incorrecta, 401 o 403 por Autenticación o problemas de autorización.

Informe de problemas

Al informar del problema Para soporte técnico, incluye lo siguiente en el informe:

  • Endpoint API

  • Solicitud

  • Hora (y zona horaria)

  • Respuesta

  • Phrase-Action- ID de la respuesta

¿Fue útil este artículo?

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.