Using APIs (TMS)

Este é um cenário de API simples com chamadas de API de amostra e instruções sobre como ligá-las junto para Concluir uma ação simples usando apenas APIs. As opções que podem ser definidas por meio das APIs são extensas. Consulte as seções respectivas da documentação da API REST para descobrir mais sobre todas as opções disponíveis.

A plataforma da API Postman foi usada para criar o cenário.

Nesses exemplos, o URL de solicitação padrão começa com https://cloud.memsource.com. Caso as APIs sejam utilizadas por uma organização no centro de dados dos EUA, o URL da solicitação deve começar com https:/us.cloud.memsource.com.

Cenário

Metodologia

Cada chamada de API REST individual tem um método apropriado listado. Usar um método incorreto (p.ex. GET em vez de POST na chamada de criação do projeto) resulta em uma chamada de API sem sucesso.

Etapa 1: Autenticação

Existem dois métodos de autenticação:

Para este cenário, é usada a chamada da API de autenticação. O token gerado é necessário para todas as chamadas de API a seguir e não está listado em parâmetros de exemplo.

Use a API Login para autenticação com os parâmetros necessários. Neste caso, são necessários nome de usuário e senha.

Membros de várias organizações TMS têm o mesmo nome de usuário e senha para várias contas. Neste caso, o userUid deve ser adicionado ao corpo de solicitação para especificar qual organização o usuário deseja acessar. Se não especificado, o usuário está conectado à conta padrão associada ao nome de usuário e senha.

Etapa 2: Criação, importação e atribuição de projeto

Criação do projeto

Use a chamada da API Projetos para criar um projeto com os parâmetros obrigatórios nome, sourceLang e targetLangs.

É possível criar um modelo de projeto usando a chamada API Criar modelo de projeto com o UID do projeto a partir da última chamada.

A maneira mais eficiente de criar projetos é usar um modelo de projeto. Use Criar projeto a partir do modelo com o UID do modelo do projeto a partir da última chamada para criar um novo projeto com base nas configurações do modelo do projeto.

A expressão {templateUid} serve como marcador de posição no URL de solicitação onde o UID do modelo do projeto obtido é inserido. 

Criação do trabalho

Com o UID do projeto na última chamada, novos trabalhos podem ser adicionados diretamente ao projeto recém-criado usando Criar trabalho.

A expressão {projectUid} serve como marcador de posição no URL de solicitação onde o UID do projeto obtido é inserido. Com a chamada da API Criar trabalho, os cabeçalhos da solicitação devem ser alterados para correspondência com as exigidas pelo phrase (em outras chamadas, o Postman adiciona automaticamente cabeçalhos apropriados à solicitação).

Todos os parâmetros importados precisam ser inseridos em um cabeçalho personalizado Memsource.

O cabeçalho Conteúdo-Disposição deve incluir o nome do arquivo em um formato predefinido para que o pedido seja processado corretamente.

Para importar um arquivo original do texto, acesse o corpo, selecione binário e a opção Selecionar arquivo aparecerá.

Use Receber solicitação assíncrona com o UID AsyncRequest da chamada Criar trabalho para verificar que o trabalho foi criado com êxito e que ele é funcional.

O UID do trabalho retornado é único em cada etapa do fluxo de trabalho do projeto. Assim, se o trabalho for criado em um projeto com fluxo de trabalho, a resposta retornará uma UID única do trabalho para cada etapa do fluxo de trabalho. 

Configurações importar reutilizáveis podem ser configuradas com a chamada Criar configurações importar. Um UID de configuração de importar que pode ser usado na chamada de trabalho do criar é recebido na resposta.

Para atribuir responsáveis ao trabalho (a menos que sejam atribuídos diretamente na chamada Criar trabalho) use a chamada Edicionar trabalho.

O ID do responsável que é inserido na chamada pode ser obtido de duas maneiras:

Notificar usuários atribuídos

O ID U do trabalho pode ser usado como um parâmetro opcional na chamada Notificar usuários atribuídos, juntamente com o parâmetro e-mail model que representa o ID do modelo de e-mail a ser usado. Isso pode ser obtido usando a chamada modelos de e-mail de lista.

É nisto que o tradutor começaria a trabalhar no seu perfil, assim como se tivesse usado a interface do phrase. Após o trabalho terminar, o GP encarregado recebe uma notificação e a Seguinte parte do cenário é iniciada. Uma chamada de retorno pode ser interceptada por meio de webhooks para iniciar automaticamente a Parte Seguinte do cenário, mas isso não será abordado neste exemplo.

Etapa 3: Baixar arquivo traduzido (concluir) e definir o projeto como concluído

Baixar arquivo traduzido

Este cenário funciona com a suposição de que um tradutor conclui seu trabalho (marca o trabalho como Concluído), mas o arquivo concluído pode ser baixado a qualquer momento, o trabalho não precisa ter o estado Concluído.  

Para baixar um arquivo traduzido, são necessárias duas chamadas de API: Baixar arquivo de tradução (assíncrono) e Baixar arquivo de tradução com base nas chamadas de solicitação assíncrono.

A primeira etapa é ligar Baixar arquivo de tradução (asincronizado) com os parâmetros projectUid e jobUid. Se você estiver baixando o arquivo concluído de um projeto com várias etapas do fluxo de trabalho, certifique-se de usar o jobUid da etapa do fluxo de trabalho específica da qual você gostaria de baixar o arquivo concluído, p.ex., etapa do fluxo de trabalho de revisão.

A chamada para baixar arquivo de tradução (asíncrono) inicia uma solicitação assíncrona para gerar e baixar o arquivo de tradução contendo traduções. Ele não fornece diretamente o arquivo de tradução dentro da resposta, mas um asyncRequestId necessário para a chamada seguinte. 

Use Receber solicitação assíncrona com o syncRequestID da resposta para verificar se a solicitação foi concluída. Depois da conclusão da solicitação assíncrona, você pode baixar o arquivo de tradução usando o arquivo de tradução baixando com base na chamada de solicitação assíncrona. O asyncRequestId só pode ser usado uma vez. Assim que o baixar é iniciado, o asyncRequestId torna-se inválido para uso adicional.

Definir projeto como concluído

Para finalizar o projeto após o trabalho no projeto Concluir, use a chamada Edicionar estado do projeto com os parâmetros obrigatórios projectUid e estado para alterar o estado de todo o projeto a ser concluído. Essa alteração é manual, mas se a automatização do estado do projeto for usada, o estado será alterado automaticamente. Também é possível esperar por um webhook e iniciar outras ações com base na chamada de retorno recebida.