Aqui estão documentadas todas as nossas APIs públicas relacionadas aos processos
Introdução
Integração por API
Esta documentação tem por finalidade auxiliar a integração com a APIs do sistema unico auto.
As API do unico | auto utilizam uma arquitetura em REST e comunicação padrão em JSON. É possível encontrar mais detalhes, nos links a seguir, sobre os temas: e .
O primeiro passo é adquirir uma conta de serviço e se autentica. Este item está detalhado a seguir, no tópico .
A URL utilizada na documentação, são todas referentes ao ambiente de produção.
Fluxo de pagamentos
Aqui estão documentadas todas as nossas APIs públicas relacionadas ao fluxo de pagamentos
PS: No próprio endpoint, após os "values=", você deverá passar os indexadores do processo que deseja alterar os indexadores, separados por vírgula (ex: 666,NOME%DO%FULANO) - percebe-se que se substitui o "espaço" pelo sinal de porcentagem "%"
Headers
Get JWT
O primeiro passo para utilizar todas as APIs subsequentes, é adquirir o JWT.
JWT (JSON Web Token) é um método RCT 7519 padrão da indústria para realizar autenticação entre duas partes por meio de um token assinado que autentica uma requisição web. Para saber mais, acesse: .
Importante: Para adquirir o JWT é necessário ter um usuário específico no sistema, criado para essa finalidade.
Caso possua acesso a gestão de usuários, você mesmo pode criar o usuário, caso não possua o acesso, basta solicitar a criação do usuário através do nosso suporte: [email protected].
<html><head><title>Error</title></head><body>Internal Server Error</body></html>
Description
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
Request Body
Name
Type
Description
establishment*
String
CNPJ onde o processo se encontra
indexers*
Array de string
Array de strings com os valores dos indexadores do processo (utilizado para localizá-lo)
{"data": [58089852
<html><head><
// Erro na propriedade "indexers"Processonaoencontrado,com
// Erro na propriedade "situationName"
Situacao nao encontrada
Exemplo de Requisição:
Importante: Os parâmetros que são passados na requisição podem ser adquiridos através do nosso suporte: [email protected].
Headers
Name
Type
Description
Content-Type*
String
application/json
Authorzation*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
{"id": 12451,
<html><head><
Relatorionaoencontrado
Importante: Através dessa API, você irá obter o último relatório gerado. Para uma melhor performance, sugerimos que solicite que seja cadastrado um agendamento no relatório, para que este esteja sempre atualizado.
A configuração de agendamento e o ID do relatório podem ser obtidos através da abertura de um chamado com o nosso suporte: [email protected].
Name
Type
Description
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
{"returnedValue": true,
ERROR
<html><head><
Iniciar processo BPM
O objetivo dessa API é automatizar o início dos processos no sistema a partir de uma requisição do tipo REST.
Nome da situação para onde o processo deve ser transicionado
Description
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
Request Body
Name
Type
Description
workflowId*
Integer
Código do tipo de processo que será iniciado
establishmentCNPJ*
String
CNPJ do estabelecimento onde o processo será iniciado
{"id": 58089890,
Exemplo de Requisição:
Importante: Os parâmetros que são passados na requisição podem ser adquiridos através da abertura de um chamado com o nosso suporte: [email protected].
Inserir documentos em processo
O objetivo dessa API é rinserir documentos em um processo no sistema a partir de um requisição do tipo REST.
<html>
<head>
<title>Error</title>
</head>
<body>Internal Server Error</body>
</html>
// Erro no parâmetro "workflowId"
Tipo de Processo não encontrado para essa conta
// Erro no parâmetro "establishmentCNPJ"
Estabelecimento não encontrado
// Erro no parâmetro "initialTransition"
Esse estagio nao e uma situacao
// Erro no parâmetro "indexers"
Indexador obrigatorio não recebido ou indexador recebido [null] não encontrado na configuração deste tipo de processo []
Array de integer que passa os códigos dos tipos de processos
initialDate
String
Consulta por data inicial. Deve ser no formato "03/11/2021 10:37:28"
finalDate
Integer
Consulta por data final. Deve ser no formato "03/11/2021 10:37:28"
searchFor
String
É o equivalente a busca geral no sistema
like
Boolean
Booleano que indica se a busca realizada no "searchFor" deve ser um like ou não
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
documentId
Array de integer
Este parâmetro está em desuso e pode ser passado vazio
establishmentIds
Array de integer
Array de integer que passa os IDs dos estabelecimentos
{"hits": 1,"time": 18,"processes": [{"processId":58089890,"createDate":"03/11/2021 10:37:28","idEstablishment":50102182,"flagReserved":"N","reservedUserId":null,"reservedInitDate":null,"nameProcessType":"PROCESSO BPM ABERTO VIA INTEGRAÇÃO","idProcessStage":1960390,"idProcessType":50029957,"idSituation":51202584,"nameSituation":"TAREFA DA PRIMEIRA TRANSIÇÃO","listSituation": [],"typeSituation":null,"idCustomer":6921,"flagDocumentsRequired":"S","missingDocuments": [],"nameEstablishment":"INTEGRAÇÕES","flagUseNotification":null,"slaTime":0,"slaType":null,"indexerVO": [{"indexerNumber":1,"indexerType":"I","indexerLabel":"INTEIRO","indexerValue":"666","indexerDetails": [],"indexerFieldName":"INTEIRO","alert":null,"id":82073974,"parentId":null,"form":false,"stageId":null,"uniqueId":null},{"indexerNumber":2,"indexerType":"S","indexerLabel":"TEXTO","indexerValue":"NOME DO FULANO","indexerDetails": [],"indexerFieldName":"TEXTO","alert":null,"id":82073975,"parentId":null,"form":false,"stageId":null,"uniqueId":null},{"indexerNumber":3,"indexerType":"D","indexerLabel":"DATA","indexerValue":"07/12/2021","indexerDetails": [],"indexerFieldName":"DATA","alert":null,"id":82073976,"parentId":null,"form":false,"stageId":null,"uniqueId":null},{"indexerNumber":4,"indexerType":"V","indexerLabel":"VALOR","indexerValue":"1.000,00","indexerDetails": [],"indexerFieldName":"VALOR","alert":null,"id":82073977,"parentId":null,"form":false,"stageId":null,"uniqueId":null} ],"documentVO": [],"reservedUserName":null,"indSelfCapture":0,"indNotifySelfCapture":0,"checklist": [],"ownerName":"INTEGRACAO","lastSituationProgressDate":"03/11/2021 10:37:28","workflow":true,"transitionsTree": [{"text":"ALTERAÇÃO DE SITUAÇÃO","stageId":1960384,"stageType":"connector","transition":null,"roles": [{"roleId":50029246,"name":"PERFIL DE USUÁRIO DE INTEGRAÇÃO"} ],"next": [{"text":"PRIMEIRA SITUAÇÃO","stageId":1960388,"stageType":"task","transition":"TRANSIÇÃO PRIMEIRA SITUAÇÃO","roles": [{"roleId":50029246,"name":"PERFIL DE USUÁRIO DE INTEGRAÇÃO"} ],"next": [],"transtionId":2406283,"actionName": []},{"text":"SEGUNDA SITUAÇÃO","stageId":1960389,"stageType":"task","transition":"TRANSIÇÃO SEGUNDA SITUAÇÃO","roles": [{"roleId":50029246,"name":"PERFIL DE USUÁRIO DE INTEGRAÇÃO"} ],"next": [],"transtionId":2406284,"actionName": []} ],"transtionId":2406290,"actionName": []} ],"swimlaneRoleName":"PERFIL DE USUÁRIO DE INTEGRAÇÃO","breadCrumbs": [],"finalSituation":false,"reservedToMe":false,"processEventNameInCurrentTransition": [],"processEstablishmentBreadCrumb": ["INTEGRAÇÕES" ],"processOwnerBreadCrumb": ["INTEGRACAO" ],"relatedDocuments": [],"processDelay":null,"childProcessIds": [],"waitingChildProcessIds": [],"parentProcessId":null} ],"filters": [{"name":"process_progress_checklist_concat","values":{}},{"name":"process_situation","values":{"TAREFA DA PRIMEIRA TRANSIÇÃO":1}},{"name":"indexers_labels","values":{"INTEIRO":1,"TEXTO":1,"DATA":1,"VALOR":1}},{"name":"user_name","values":{"INTEGRACAO":1}},{"name":"check_label_prev_text","values":{}},{"name":"check_label_prev","values":{}},{"name":"check_label_next_text","values":{}},{"name":"indexers_labels_types_names","values":{"VALOR|V|null":1,"INTEIRO|I|null":1,"TEXTO|S|null":1,"DATA|D|null":1}},{"name":"establishment","values":{"INTEGRAÇÕES":1}},{"name":"process_type","values":{"PROCESSO BPM ABERTO VIA INTEGRAÇÃO":1}},{"name":"situation","values":{}},{"name":"establishment_group","values":{"INTEGRAÇÕES":1}},{"name":"document_type","values":{"":1}} ]}
processTypeIds
<html>
<head>
<title>Error</title>
</head>
<body>Internal Server Error</body>
</html>
// Erro na propriedade "workflowId"
Tipo de processo não encontrado -- process.getIdProcessType(): null -- captureDomain.getWorkflowId(): 5002995
// Erro na propriedade "documentTypeId"
Tipo de documento não encontrado para essa conta
// Erro na propriedade "indexers"
Indexador obrigatorio não recebido ou indexador recebido [INTEI] não encontrado na configuração deste tipo de processo [50.029.958]
<html>
<head>
<title>Error</title>
</head>
<body>Internal Server Error</body>
</html>