Pular para o conteúdo principal
Um cenário típico para processar documentos usando uma única chamada de API (para criar uma transação, enviar um arquivo e iniciar uma transação) consiste nas seguintes etapas:
  1. Receber uma lista de todas as Skills disponíveis.
  2. Criar e iniciar a transação.
  3. Monitorar o status da transação.
  4. Fazer download dos arquivos de origem e dos arquivos de resultado.
Cada solicitação ao servidor deve incluir informações de autenticação. Para obter mais informações, consulte Authentication. Use este cenário se você tiver um arquivo com menos de 30 MB e não precisar editar as imagens desse arquivo.

Etapa 1. Obter uma lista de todas as skills disponíveis

Para isso, envie uma solicitação GET para o recurso skills: Execute o seguinte comando: Como resultado, você receberá informações sobre todas as skills adicionadas à instância do aplicativo.

Etapa 2. Criar e iniciar uma transação

Para criar e iniciar uma transação, envie uma solicitação POST para o recurso transactions/launch: Na URL, especifique o parâmetro de consulta skillId (retornado pela chamada de API anterior). No corpo da requisição, envie o arquivo a ser processado junto com metadados opcionais. Você também pode passar os registrationParameters e skillParameters opcionais no corpo da requisição. Veja a seguir um exemplo de corpo de requisição:
{
  "files": [
    {
    }
  ]
}
Execute o seguinte comando: Como resultado, você receberá uma resposta com o id da transação criada.

Etapa 3. Monitorar o status da transação

Para isso, envie uma solicitação GET para o recurso transactions: Execute o comando a seguir: Como resultado, você receberá uma resposta com o status da transação. O processamento da transação pode estar em um dos seguintes status:
  • New. A transação foi criada, mas ainda não foi colocada na fila para processamento.
  • Queued. A transação está na fila para processamento.
  • InProgress. A transação está sendo processada.
  • Processed. A transação foi processada com sucesso.
  • ProcessedWithWarnings. A transação foi processada, mas ocorreram avisos.
  • NotProcessed. A transação não foi processada devido a um erro.
  • Deleted. A transação foi excluída pelo usuário ou automaticamente pela política de retenção.
Se o status da transação for Processed ou ProcessedWithWarnings, vá para a etapa 4.

Etapa 4. Baixar arquivos de origem e arquivos de resultado

Para baixar arquivos de origem e arquivos de resultado, envie uma solicitação GET ao recurso transactions/files/download, especificando o ID do arquivo recebido na solicitação anterior: Execute o seguinte comando: