Tecnologia de API (TMS)

Nossa API vê entidades de aplicação (projetos, trabalhos, configurações) como recursos que podem ser recuperados, criados, modificados e excluídos. 

Cada método HTTP representa uma ação:

As entidades usam uma estrutura plana sempre que possível para manter bons tempos de resposta. Em vez de incluir objetos secundários inteiros nas respostas, são contidas referências que contêm o ID, UID e alguns outros atributos. São esperados objetos IDReference ou UidReference para referenciar entidades relacionadas.

Todas as listas de resposta são paginadas. Usar os parâmetros pageNumber e pageSize para recuperar os dados solicitados. O tamanho máximo da página é 50.

Documentação

OpenAPI 3.0 é usado para Documentação de API. Geradores de código Swagger são recomendados para o desenvolvimento de cliente.

Exemplos de API

Obter lista de todas as memórias de tradução

GET

/web/api2/v1/transMemories

Resposta

200

{
    "pageNumber": 0,
    "content": [
        {
            "internalId": 1,
            "createdBy": {
                "userName": "admin",
                "id": "3",
                "firstName": "Jan",
                "lastName": "Janocko",
                "role": "ADMIN",
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            "note": "não é necessário usar na memória de tradução",
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                "es",
                "it"
            ],
            "subDomain": null,
            "businessUnit": {
                "id": "1",
                "name": "First BU"
            },
            "sourceLang": "en",
            "domain": null,
            "name": "My new TM"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Criar nova memória de tradução

POST

/web/api2/v1/transMemories

{{
"name": "My new TM",
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"note": "não é necessário usar na memória de tradução"
}

Resposta

201

{
    "internalId": 1,
    "createdBy": {
        "userName": "admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "role": "ADMIN",
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "note": "não é necessário usar na memória de tradução",
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        "es",
        "it"
    ],
    "subDomain": null,
    "businessUnit": {
        "id": "1",
        "name": "First BU"
    },
    "sourceLang": "en",
    "domain": null,
    "name": "My new TM"
}

Adicionando arquivos ao criar um trabalho

Adicionar este arquivo ao corpo da requisição como um anexo binário. Certifique-se de que o Phrase e os cabeçalhos Content-Disposition estejam inseridos corretamente.

Exemplo de PHP do Postman:

<?php

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

$request->setQueryData(array("
'token' => 'Seu token vai aqui'
));

$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\\\\\"}}'
));

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

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

Tratamento de erro

Se houver um problema ao processar uma requisição de API, a seguinte estrutura JSON será retornada. O código de erro sempre estará presente; a descrição detalhada pode ser nula.

{ "errorCode": "InvalidArguments",
"errorDescription": "O argumento obrigatório \"password\" do tipo \"string\" está ausente."
}

Uma resposta de erro pode ser detectada lendo o código de estado da resposta HTTP. Se ocorrer um erro, ele nunca será definido como 2xx. O código de estado é 400 bad request, 401 ou 403 para problemas de autenticação ou autorização.

Relatando problemas

Ao relatar um problema ao Suporte Técnico, inclua o seguinte no relatório: