Pular para o conteúdo principal
Um cenário típico de processamento de documentos usando chamadas de API separadas (para criar uma transação, enviar um arquivo e iniciar uma transação) consiste nas seguintes etapas:
  1. Receber a lista de todas as skills disponíveis
  2. Criar uma transação vazia
  3. Adicionar um conjunto de arquivos a serem processados na transação
  4. Iniciar a transação
  5. Monitorar o status da transação
  6. Baixar os arquivos de origem e os arquivos de resultado
Cada solicitação ao servidor deve incluir informações de autenticação (como um token de acesso). Para mais informações, consulte Autenticação.

​
Obtendo uma lista de todas as skills disponíveis

Para isso, envie uma solicitação GET ao recurso skills: 
GET https://seu-servidor/api/publicapi/v1/skills
Execute o comando a seguir: 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 uma transação vazia

Para isso, envie a seguinte requisição POST ao recurso transactions: 
POST https://seu-servidor/api/publicapi/v1/transactions
Execute o seguinte comando: No Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "Accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
No Linux: 
curl -X POST 'https://seu-servidor/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
No corpo da solicitação, especifique o parâmetro skillId, retornado pela chamada de API anterior. Como resultado, você receberá uma resposta contendo o id da transação criada.

​
Adicionando um conjunto de arquivos para processamento na transação

Importante! O número máximo de arquivos em uma transação é 1000. Um conjunto de arquivos pode ser adicionado de duas maneiras:

​
Adicionando arquivos diretamente à transação

Para isso, envie uma solicitação POST para o recurso transactions/<transaction-id>/files: 
POST https://seu-servidor/api/publicapi/v1/transactions/id-da-transacao/files
No corpo da solicitação, envie o arquivo a ser processado. Para obter detalhes sobre os parâmetros disponíveis para personalizar os arquivos, consulte a Referência da API. Execute o seguinte comando: No Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
No Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Como resultado, você receberá uma resposta com uma lista dos arquivos adicionados e seus identificadores. Você pode adicionar quantos arquivos precisar repetindo essa chamada várias vezes. Opções adicionais para enviar arquivos:

​
Adicionando arquivos a um documento

Primeiro, crie um documento enviando uma solicitação POST para o recurso transactions/<transaction-id>/documents: 
POST https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents
No Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
No Linux: 
curl -X POST 'https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
Como resultado, você receberá uma resposta com o identificador do documento. Em seguida, adicione arquivos ao documento enviando uma solicitação POST para o recurso transactions/<transaction-id>/documents/<document-id>/sourceFiles: 
POST https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
No Windows: 
curl -X POST "https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
No Linux: 
curl -X POST 'https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
Iniciando a transação

Para iniciar a transação com a skill e os arquivos especificados, envie a seguinte requisição POST ao recurso transactions/<transaction-id>/start: 
POST https://seu-servidor/api/publicapi/v1/transactions/transaction-id/start
No Windows: 
curl -X POST "https://seu-servidor/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
No Linux: 
curl -X POST 'https://seu-servidor/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
Monitorando o status da transação

Para começar a monitorar o status da transação usando um loop com um pequeno tempo de espera (não recomendamos verificar o status com mais frequência do que uma vez por segundo), envie uma solicitação GET para o recurso transactions/<transaction_id> com o identificador da transação no URI da solicitação: 
GET https://seu-servidor/api/publicapi/v1/transactions/id-da-transacao
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 enfileirada para processamento.
  • Queued. A transação está enfileirada para processamento.
  • InProgress. A transação está em processamento.
  • Processed. A transação foi processada com sucesso.
  • ProcessedWithWarnings. A transação foi processada, mas houve 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 6.

​
Download dos arquivos-fonte

Para obter uma lista de documentos com seus identificadores, envie uma solicitação GET para o recurso transactions/<transaction-id>/documents e especifique o identificador da transação: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
No Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'
Como resultado, você receberá uma lista de todos os documentos criados nesta transação. A resposta também contém os identificadores desses documentos, que podem ser necessários para solicitar informações detalhadas sobre documentos específicos. Para solicitar a lista de arquivos adicionados a um documento específico, envie uma requisição GET para o recurso transactions/<transaction-id>/documents/<document-id>: 
GET https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id
No Windows: 
curl -X GET "https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://seu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
Como resultado, você receberá informações sobre o documento. A resposta também contém os identificadores dos arquivos adicionados ao documento. Para baixar o arquivo de origem, envie uma solicitação GET para o recurso transactions/<transaction-id>/files/<file-id>/download: 
GET https://seu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download
No Windows: 
curl -X GET "https://seu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
No Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'