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

​
Obtendo uma lista de todas as skills disponíveis

Para isso, envie uma solicitação GET para o recurso skills: 
GET https://seu-servidor/api/publicapi/v1/skills
Execute o seguinte comando: No Windows: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Como resultado, você receberá informações sobre todas as skills adicionadas à instância do aplicativo.

​
Criando e iniciando uma transação

Para isso, envie uma requisição POST para o recurso transactions/launch: 
POST https://seu-servidor/api/publicapi/v1/transactions/launch
No corpo da solicitação, especifique o parâmetro skillId, retornado pela chamada de API anterior, e envie o arquivo a ser processado. Um exemplo de corpo da solicitação pode ser o seguinte: 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "conteúdo da imagem"
    }
  ]
}
Execute o seguinte comando: No Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
No Linux: 
curl -X POST 'https://seu-servidor/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Como resultado, você receberá uma resposta contendo o id da transação criada.

​
Monitorando o status da transação

Para isso, envie uma solicitação GET para o recurso transactions: 
GET https://seu-servidor/api/publicapi/v1/transactions/id-da-transacao
Execute o comando a seguir: No Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
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.

​
Baixando arquivos de origem e arquivos de resultado

Para baixar o arquivo de origem, envie uma solicitação GET ao recurso transactions/files/download, especificando o ID do arquivo recebido na solicitação anterior: 
GET https://seu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Execute o seguinte comando: Para Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://seu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'