1 de 22

UnicoAuto

Introdução

Integração por API

Esta documentação tem por finalidade auxiliar a integração com a APIs do sistema unico auto.

A URL utilizada na documentação, são todas referentes ao ambiente de produção.

API

Autenticação

Antes de utilizar nossas APIs, você obrigatoriamente necessita se autenticar no sistema

Para a autenticação, utilizamos um padrão JWT, conforme explicitado na documentação abaixo:

Get JWT

O primeiro passo para utilizar todas as APIs subsequentes, é adquirir o JWT.

POST https://webservices.vianuvem.com.br/AdminVianuvem/public/token

Headers

Name

Type

Description

Content-Type*

String

application/json

Request Body

Name

Type

Description

String

pass*

String

Senha do usuário que será autenticado

encryptedPass*

Boolean

Booleano que indica se a senha está encriptada ou não (orientamos que sempre utilize a senha encriptada, por segurança)

{
    "token": "iOiJIUzI1NiJ9.eyJzdWIiOiJPUklHSU5BTC5CS1BTIiwidXNlciI6Ik9SSUdJTkFMLkJLUFMiLCJwYXNzd29yZCI6ImQxODM1YjlmODllMDYyODRjYmMzNzg3Y2E3NDdiNjZmIiwidXNlcklkIjo1MDExMDM1NywiZXhwIjoxNjM2MjE1MjM1fQ.K1HoTd9_1Eo7E7yBbzonm_QWcFBC3f4HYjfpULkJkDA"
}

{
    "data": [],
    "errors": [
        {
            "message": "Ocorreu um erro inesperado"
        }
    ]
}

Exemplo de Requisição:

{
    "login": "INTEGRACAO",
    "pass": "integracao@12312321",
    "encryptedPass": false
}

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: suporte@vianuvem.com.br.

Processos

Aqui estão documentadas todas as nossas APIs públicas relacionadas aos processos

Iniciar processo BPM

O objetivo dessa API é automatizar o início dos processos no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/create

Headers

Name

Type

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

observation*

String

Comentários do processo. Pode ser vazio

isIntegration*

Boolean

Booleano que indica se o processo será iniciado a partir de uma integração. Neste caso, sempre será "true"

initialTransition*

Array de strings

Array de string que indica as opções no início do fluxo (perguntas iniciais dos decisores). Dependendo do fluxo, pode ser vazio

indexers*

Array de objetos

Array de objetos que indica quais são os indexadores do processo que será iniciado

sequence*

Integer

Sequência do indexador no processo (pertence a propriedade "indexers")

indexerLabel*

String

Nome do campo ou label que o indexador possui (pertence a propriedade "indexers")

indexerValue*

String

Valor que o indexador da label acima irá possuir (pertence a propriedade "indexers")

indexerType*

String

Tipo do indexador (pertence a propriedade "indexers"):

I - Inteiro

S - String

V - Valor

L - Lista

D - Data

M - Data múltipla

{
    "id": 58089890,
    "stageDocumentTypes": [
        {
            "documentTypeId": 70033766,
            "documentTypeName": "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO",
            "icon": null,
            "required": false,
            "sequence": null,
            "slaTime": null,
            "indexers": [],
            "desired": false,
            "attachments": [],
            "devices": null,
            "hasForm": false,
            "exists": false,
            "flagDisabled": false,
            "flagRestrainCapture": false,
            "formPrintTemplate": [],
            "form": false
        }
    ],
    "flagSelfCapture": false
}

<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 []

Exemplo de Requisição:

{
	"workflowId": 5002995,
	"establishmentCNPJ": "73386365000",
	"observation":"",
	"isIntegration":"true",
    	"initialTransition": ["PRIMEIRA TRANSIÇÃO"],
	"indexers":
		[
			{
				"sequence":1,
				"indexerLabel":"INTEIRO",
				"indexerValue":"666",
				"indexerType":"I"
			},
			{
				"sequence":2,
				"indexerLabel":"TEXTO",
				"indexerValue":"NOME DO FULANO",
				"indexerType":"S"
			},
			{
				"sequence":3,
				"indexerLabel":"DATA",
				"indexerValue":"07/12/2021",
				"indexerType":"D"
			},
			{
				"sequence":4,
				"indexerLabel":"VALOR",
				"indexerValue":"1.000,00",
				"indexerType":"V"
			}
		]
}

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: suporte@vianuvem.com.br.

Consultar processos

O objetivo dessa API é realizar a consulta de processos no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/search

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name

Type

Description

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

processTypeIds

Array de integer

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

Boolean

Booleano que indica se a busca realizada no "searchFor" deve ser um like ou não

{
    "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
            }
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"documentId": [],
	"establishmentIds": [],
	"processTypeIds": [],
	"documentTypeIds": [],
	"initialDate": "03/11/2021 10:37:28",
	"finalDate": "",
	"searchFor": "NOME DO FULANO",
	"like": false
}

Inserir documentos em processo

O objetivo dessa API é rinserir documentos em um processo no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/document

Headers

Name

Type

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 do estabelecimento onde o processo se encontra

indexers*

Array de string

Array de strings com os valores dos indexadores do processo

documentTypeId*

String

Código do tipo de documento onde o documento que será inserido pela API será categorizado no sistema

originalFileName*

String

Nome do arquivo que será inserido com sua extensão (ex: arquivo.pdf)

documentAsBase64*

String

Documento em base 64

{
    "data": [
        58089852
    ],
    "errors": []
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO"],
     "documentTypeId": "70033766",
     "originalFileName": "jpeg.jpeg",
     "documentAsBase64": "/9j/4AAQSkZJRgABAQAA...
     }

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através do nosso suporte: suporte@vianuvem.com.br.

Mudar situação de processo

O objetivo dessa API é mudar a situação de um processo no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/changeSituation

Headers

Name

Type

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)

situationName*

String

Nome da situação para onde o processo deve ser transicionado

{
    "data": [
        58089852
    ],
    "errors": []
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

// Erro na propriedade "indexers"
 Processo nao encontrado, com base nas informacoes de busca enviadas: Indexadores=[666, NOME DO FULAN]

// Erro na propriedade "situationName"
Situacao nao encontrada

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO"],
     "situationName": "SEGUNDA SITUAÇÃO"
}

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através do nosso suporte: suporte@vianuvem.com.br.

Inserir comentários em processo

O objetivo dessa API é inserir comentários em um processo no sistema a partir de uma requisição do tipo REST

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/comments

Headers

Name

Type

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*

String

Array de strings com os valores dos indexadores do processo (utilizado para localizá-lo)

comments*

String

Comentário que será inserido no processo

{
    "data": [
        58089852
    ],
    "errors": []
}

// Erro na propriedade "indexers"
Processo nao encontrado, com base nas informacoes de busca enviadas: Indexadores=[666, NOME DO FULAN]

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO", "07/12/2021"],
     "comments": "TESTE DE COMENTÁRIOS"
}

Alterar indexadores de um processo

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/v1/processes/indexers?values=666

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

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name

Type

Description

indexers*

Array de objetos

Array de objetos que indica quais são os indexadores do processo que serão alterados

label*

String

Label do indexador que será alterado (pertence a propriedade "indexers")

value*

String

Valor que o indexador da label acima irá possuir (pertence a propriedade "indexers")

{
    "data": {
        "id": 58089890
    },
    "errors": []
}

{
    "data": [],
    "errors": [
        {
            "message": "\"Nenhum processo encontrado\""
        }
    ]
}

{
    "data": [],
    "errors": [
        {
            "message": "\"Mais de um processo encontrado\""
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "indexers": [
     {
          "label": "DATA",
          "value": "10/10/2010"
     },
     {
          "label": "VALOR",
          "value": "2.000,00"
     }
     ]
}

Fluxo de pagamentos

Aqui estão documentadas todas as nossas APIs públicas relacionadas ao fluxo de pagamentos

Lançar um documento no fluxo de pagamentos

O objetivo dessa API é automatizar o lançamentos de documentos do fluxo de pagamentos no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/document/capture

Headers

Name

Type

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 onde o documento será lançado

establishment*

Integer

CNPJ do estabelecimento onde o documento será lançado

documentVOList*

Array de objetos

Array de objetos com as propriedades do tipo de documento que será lançado no sistema

documentTypeId*

Integer

Código do tipo de documento onde o documento que será inserido pela API será categorizado no sistema

documentObjetcs*

Array de objetos

Array de objetos com as propriedades do documento que será lançado no sistema

attachments

Array de string

Array de strings onde é passado os anexos que um documento pode ter. Sempre em base 64

indexers*

Array de objetos

Array de objetos que indica quais são os indexadores do processo que será iniciado

sequence*

Integer

Sequência do indexador no processo (pertence a propriedade "indexers")

indexerTypeName*

String

Nome do campo ou label que o indexador possui (pertence a propriedade "indexers")

indexerValue*

String

Valor que o indexador da label acima irá possuir (pertence a propriedade "indexers")

indexerType*

String

Tipo do indexador (pertence a propriedade "indexers"):

I - Inteiro

S - String

V - Valor

L - Lista

D - Data

M - Data múltipla

name*

String

Nome do arquivo que será inserido com sua extensão (ex: arquivo.pdf)

observation

String

Comentário do documento. Pode ser vazio

objectTypeId*

Integer

Sempre será 2

documentObjectAsBase64*

String

Documento em base 64

{
    "documents": [
        {
            "documentId": 27923418,
            "createDate": "2021-11-03T13:27:33.907-03:00",
            "status": false,
            "currentVersion": 1,
            "documentTypeId": 700766,
            "accountId": 50182,
            "documentObjects": [
                {
                    "documentObjectId": 279234187,
                    "storageLocal": "d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202.original.pdf",
                    "objectSize": null,
                    "objectTypeId": 70033766,
                    "createDate": "2021-11-03T13:27:33.907-03:00",
                    "fullSignedPath": "https://cdn.vianuvem.com.br/d2f7c1a59153e5d/1b1aa6c0f50980c23d2a7c285d9aef68.original.pdf?Expires=1636316855&Signature=r19g4ux329mgv2uUIbea6je01RYSIG4ULH2FkbKH3R60WV0yuW~YU7d0B4PCbIWs51Y-d5TbGoFtQoja641xg5E613WLl7BKBsMZI3IrlZnsqduLu4wi~QchAwoKC9wZjTLMysMeLr5oZoQMkQs1x7wFyve-LfuCCUeJmxg2pbLomSlHMn7NUbf~eqUTimaQvh7sQjgWQ9pOvgTovFbYo7N0fBcQz1jxOwFf4PBovG7lB9Fx~bVuI5Pu4pUlwTlC99GthaAgMw43CjS-DqRKYP~ZWQALjEre3i2rQe5BYovZk3QGHnJfwM0AhkvOSw053lAf6x~g5gWAV~jjfJn6mg__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA"
                }
            ],
            "workflowInstanceId": null
        }
    ],
    "transitionsTree": []
}

// 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>

Exemplo de requisição:

{ 
	"workflowId": 50029958,
	"establishmentCNPJ": 73386365000170,
	"documentVOList": 
	[ 
		{ 
			"documentTypeId": 70033766,
			"documentObjects": 
			[ 
				{ 
					"attachments": [],
					"indexers": 
					[
						{
							"sequence":1, 
							"indexerTypeName":"INTEIRO", 
							"indexerValue":"1234", 
							"indexerType":"I" 
						},
                        {
							"sequence":2, 
							"indexerTypeName":"TEXTO", 
							"indexerValue":"TESTE", 
							"indexerType":"S" 
						}
					],
					"name":"pdf.pdf",
					"objectSize":0,
					"observation":"Inserido via integração",
					"objectTypeId":2,
					"documentObjectAsBase64":
						"JVBERi0xLZjN1BO7q9Rgo..."
			}
		]
	}
]
}

Consultar documentos

O objetivo dessa API é realizar a consulta de documentos no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/document/search

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name

Type

Description

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

processTypeIds

Array de integer

Array de integer que passa os códigos dos tipos de processos

documentTypeIds

Array de integer

Array de integer que passa os códigos dos tipos de documentos

initialDate

String

Consulta por data inicial. Deve ser no formato "03/11/2021 10:37:28"

finalDate

String

Consulta por data final. Deve ser no formato "03/11/2021 10:37:28"

searchFor

String

É o equivalente a busca geral no sistema

{
    "hits": 1,
    "time": 4,
    "documents": [
        {
            "idDocument": 279236533,
            "idUser": 50102188,
            "createDate": "03/11/2021 13:30:56",
            "idProcessType": 50029958,
            "processTypeDescription": "PROCESSO DE NOTAS VIA INTEGRAÇÃO",
            "idProcess": null,
            "documentTypeDescription": "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO",
            "idDocumentType": 70033766,
            "idMimeType": 5,
            "establishmentName": "INTEGRAÇÕES",
            "userName": "INTEGRACAO",
            "idSituationCheck": "C",
            "flagDocumentCheck": "S",
            "idCheck": null,
            "mimeType": "image/jpeg",
            "idEstablishment": 50102182,
            "documentAssigned": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.original.jpg?Expires=1636317756&Signature=izIDgSlV1SAko4gx1MdVoYFXPQtqA4LMLH7roy~Cx5sW5ZvSx5bA7C7~Cli7k23BbHvfyaMY3KQL7RFqxHY~2AYHQRJhg1v6L2DJN9KRMUzYmivod5nC5R2t~2GuxMKsb9FeF645H-NZPuUb6nDJCh2it0wI-QkWMZQSk6MApxX0s5SGM2M21nboozVR99h~50pHBL2NjrqaHRu6r~IyjZF8vjEoV3GeS0Htcz2F0DcRzMNdf64s~H1WvDPNotf9QsQ3VX34hvSqIsPDEhKqmpNgmUNpUuTQUJmVoKsYkDSplOXrHEfMsfkTXQPkbkzoOdssfgAh5KfQW99Ljc0fmA__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "documentThumbSmallAssigned": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.thumb-small.jpg?Expires=1636317756&Signature=iX4CKPAeKNVXxHSlCpQejodzC2LgQp2UiCWUu67Kp2GykfrGcmlrhXo5W~Xc1bg~i6hXn0yrkqwOoQCBEjlPqZeQrmsJB3JDWBCwgMNFW6jCEyuevrvG9Ugzv9iAJraxGSK8jlHZgsc3~HPdGaUvdlEBV1g7Lhn3bj9CaO8iuvidpAa6qWMMvL-QpJyMSzpyM0Dap9vs0CewyNPIps2yPF7GaFqdA5hfdY8pk6wMLuRVDFb7nAVF6XthLHiJOxORjXz6pKypLrf5a-pL8O-DGfTQH5jGdpMvF2Pvx33kOHL-FpD3kvkPh3~G1Rwe8xH7WjSy2mZxaFZZTb1vTOK8NQ__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "indexers": [
                {
                    "indexerNumber": 1,
                    "indexerType": "I",
                    "indexerLabel": "INTEIRO",
                    "indexerValue": "1234",
                    "indexerDetails": [],
                    "indexerFieldName": "INTEIRO",
                    "alert": null,
                    "id": 577186245,
                    "parentId": 50047879,
                    "form": false,
                    "stageId": null,
                    "uniqueId": null
                },
                {
                    "indexerNumber": 2,
                    "indexerType": "S",
                    "indexerLabel": "TEXTO",
                    "indexerValue": "TESTE",
                    "indexerDetails": [],
                    "indexerFieldName": "TEXTO",
                    "alert": null,
                    "id": 577186246,
                    "parentId": 50047880,
                    "form": false,
                    "stageId": null,
                    "uniqueId": null
                }
            ],
            "documentAttachments": [],
            "documentRestrict": null,
            "documentLastComment": "Inserido via integração",
            "signatures": null,
            "selfCaptureId": null,
            "capturedBy": null,
            "downloadUrl": "https://cdn.vianuvem.com.br/d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202c76eb3e5d/ff77a46969b064b97a44426bc557ce28.original.jpg?Expires=1636317756&Signature=izIDgSlV1SAko4gx1MdVoYFXPQtqA4LMLH7roy~Cx5sW5ZvSx5bA7C7~Cli7k23BbHvfyaMY3KQL7RFqxHY~2AYHQRJhg1v6L2DJN9KRMUzYmivod5nC5R2t~2GuxMKsb9FeF645H-NZPuUb6nDJCh2it0wI-QkWMZQSk6MApxX0s5SGM2M21nboozVR99h~50pHBL2NjrqaHRu6r~IyjZF8vjEoV3GeS0Htcz2F0DcRzMNdf64s~H1WvDPNotf9QsQ3VX34hvSqIsPDEhKqmpNgmUNpUuTQUJmVoKsYkDSplOXrHEfMsfkTXQPkbkzoOdssfgAh5KfQW99Ljc0fmA__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA",
            "processCreateDate": null,
            "processSituation": null,
            "processSituationId": null,
            "processOwnerId": null,
            "processUserReservedId": null,
            "processUserName": null,
            "processReservedDate": null,
            "processReservedUserName": null,
            "customerId": 6921,
            "relatedDocuments": [],
            "requiredInProcess": false,
            "checkNext": [],
            "checkPrev": [],
            "currentCheck": null,
            "situation": "Conferido",
            "currentCheckPosition": null,
            "checklist": [],
            "lastSituationProgressDate": null,
            "indexersDynamic": [],
            "establishmentCnpj": "73386365000170",
            "workflow": false,
            "processStageId": null,
            "transitionsTree": [],
            "swimlaneRoleName": null,
            "breadCrumbs": [],
            "establishmentGroupName": [
                "INTEGRAÇÕES"
            ],
            "hasAllRequiredDocuments": false,
            "processFinalSituation": false,
            "processEventNameInCurrentTransition": null,
            "processEstablishmentBreadCrumb": null,
            "processOwnerBreadCrumb": null,
            "attachedForms": null,
            "documentInviteStatus": null,
            "documentInvites": [],
            "hasCollaboration": false,
            "processDelay": null,
            "hasSignature": false,
            "lastConferenceDate": null,
            "documentCheckDelayDate": null,
            "formSnapshotId": null,
            "parentProcessId": null,
            "childProcessIds": null,
            "waitingChildProcessIds": null,
            "form": false,
            "my": true
        }
    ],
    "filters": [
        {
            "name": "process_progress_checklist_concat",
            "values": {}
        },
        {
            "name": "process_situation",
            "values": {}
        },
        {
            "name": "indexers_labels",
            "values": {
                "INTEIRO": 1,
                "TEXTO": 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": {
                "INTEIRO|I|INTEIRO": 1,
                "TEXTO|S|TEXTO": 1
            }
        },
        {
            "name": "establishment",
            "values": {
                "INTEGRAÇÕES": 1
            }
        },
        {
            "name": "process_type",
            "values": {
                "PROCESSO DE NOTAS VIA INTEGRAÇÃO": 1
            }
        },
        {
            "name": "situation",
            "values": {
                "Conferido": 1
            }
        },
        {
            "name": "establishment_group",
            "values": {
                "INTEGRAÇÕES": 1
            }
        },
        {
            "name": "document_type",
            "values": {
                "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO": 1
            }
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"documentId": [],
	"establishmentIds": [],
	"processTypeIds": [],
	"documentTypeIds": [],
	"initialDate": "",
	"finalDate": "",
	"searchFor": "1234"
}

Consulta XML

O objetivo dessa API é realizar a consulta de XMLs no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/integration/nfe/xml

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name

Type

Description

cnpjNumber*

String

CNPJ do fornecedor da nota fiscal

nfeNumber*

String

Número da nota fiscal

<nfeProc versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe">
    <NFe xmlns="http://www.portalfiscal.inf.br/nfe">
        <infNFe versao="4.00" Id="NFe35191104952112000101550010001641221565130774">
            <ide>
                <cUF>35</cUF>
                <cNF>56513077</cNF>
                <natOp>DEV. MERCADORIAS SUBST.TRIB. (PECAS)</natOp>
                <mod>55</mod>
                <serie>1</serie>
                <nNF>164122</nNF>
                <dhEmi>2019-11-14T15:23:00-03:00</dhEmi>
                <tpNF>0</tpNF>
                <idDest>1</idDest>
                <cMunFG>3550308</cMunFG>
                <tpImp>1</tpImp>
                <tpEmis>1</tpEmis>
                <cDV>4</cDV>
                <tpAmb>1</tpAmb>
                <finNFe>4</finNFe>
                <indFinal>1</indFinal>
                <indPres>1</indPres>
                <procEmi>0</procEmi>
                <verProc>NBS 01.013</verProc>
                <NFref>
                    <refNFe>35191104952112000101550010001633261565130770</refNFe>
                </NFref>
            </ide>
            <emit>
                <CNPJ>04952112000101</CNPJ>
                <xNome>Calmotors Ltda</xNome>
                <xFant>Calmotors</xFant>
                <enderEmit>
                    <xLgr>PACAEMBU</xLgr>
                    <nro>343</nro>
                    <xBairro>Barra Funda</xBairro>
                    <cMun>3550308</cMun>
                    <xMun>SAO PAULO</xMun>
                    <UF>SP</UF>
                    <CEP>01155000</CEP>
                    <cPais>1058</cPais>
                    <xPais>BRASIL</xPais>
                    <fone>1136655500</fone>
                </enderEmit>
                <IE>110147097118</IE>
                <IM>31350712</IM>
                <CNAE>4511101</CNAE>
                <CRT>3</CRT>
            </emit>
            <dest>
                <CNPJ>00434116002697</CNPJ>
                <xNome>MAIS DISTRIBUIDORA </xNome>
                <enderDest>
                    <xLgr>VERGUEIRO</xLgr>
                    <nro>4911</nro>
                    <xBairro>VILA MARIANA</xBairro>
                    <cMun>3550308</cMun>
                    <xMun>SAO PAULO</xMun>
                    <UF>SP</UF>
                    <CEP>04101300</CEP>
                    <cPais>1058</cPais>
                    <xPais>BRASIL</xPais>
                    <fone>1150893000</fone>
                </enderDest>
                <indIEDest>1</indIEDest>
                <IE>144800095116</IE>
                <email>1@2.com.br</email>
            </dest>
            <det nItem="1">
                <prod>
                    <cProd>K05033307AD</cProd>
                    <cEAN>SEM GTIN</cEAN>
                    <xProd>SENSOR POSICAO</xProd>
                    <NCM>87081000</NCM>
                    <CEST>0000000</CEST>
                    <indEscala>S</indEscala>
                    <CFOP>1411</CFOP>
                    <uCom>UN</uCom>
                    <qCom>1.0000</qCom>
                    <vUnCom>255.9000000000</vUnCom>
                    <vProd>255.90</vProd>
                    <cEANTrib>SEM GTIN</cEANTrib>
                    <uTrib>UN</uTrib>
                    <qTrib>1.0000</qTrib>
                    <vUnTrib>255.9000000000</vUnTrib>
                    <vDesc>75.90</vDesc>
                    <indTot>1</indTot>
                </prod>
                <imposto>
                    <ICMS>
                        <ICMS60>
                            <orig>0</orig>
                            <CST>60</CST>
                            <vBCSTRet>0.00</vBCSTRet>
                            <pST>0.0000</pST>
                            <vICMSSubstituto>0</vICMSSubstituto>
                            <vICMSSTRet>0.00</vICMSSTRet>
                            <pRedBCEfet>0.0000</pRedBCEfet>
                            <vBCEfet>180.00</vBCEfet>
                            <pICMSEfet>18.0000</pICMSEfet>
                            <vICMSEfet>32.40</vICMSEfet>
                        </ICMS60>
                    </ICMS>
                    <PIS>
                        <PISOutr>
                            <CST>99</CST>
                            <vBC>180.00</vBC>
                            <pPIS>0.0000</pPIS>
                            <vPIS>0.00</vPIS>
                        </PISOutr>
                    </PIS>
                    <COFINS>
                        <COFINSOutr>
                            <CST>99</CST>
                            <vBC>180.00</vBC>
                            <pCOFINS>0.0000</pCOFINS>
                            <vCOFINS>0.00</vCOFINS>
                        </COFINSOutr>
                    </COFINS>
                </imposto>
            </det>
            <total>
                <ICMSTot>
                    <vBC>0.00</vBC>
                    <vICMS>0.00</vICMS>
                    <vICMSDeson>0.00</vICMSDeson>
                    <vFCP>0.00</vFCP>
                    <vBCST>0.00</vBCST>
                    <vST>0.00</vST>
                    <vFCPST>0.00</vFCPST>
                    <vFCPSTRet>0.00</vFCPSTRet>
                    <vProd>255.90</vProd>
                    <vFrete>0.00</vFrete>
                    <vSeg>0.00</vSeg>
                    <vDesc>75.90</vDesc>
                    <vII>0.00</vII>
                    <vIPI>0.00</vIPI>
                    <vIPIDevol>0.00</vIPIDevol>
                    <vPIS>0.00</vPIS>
                    <vCOFINS>0.00</vCOFINS>
                    <vOutro>0.00</vOutro>
                    <vNF>180.00</vNF>
                </ICMSTot>
            </total>
            <transp>
                <modFrete>9</modFrete>
            </transp>
            <pag>
                <detPag>
                    <tPag>90</tPag>
                    <vPag>0.00</vPag>
                </detPag>
            </pag>
            <infAdic>
                <infCpl>Devolucao Total da nota : 163326 /5</infCpl>
            </infAdic>
            <infRespTec>
                <CNPJ>02348447000181</CNPJ>
                <xContato>GERSON DA COSTA TEIXEIRA</xContato>
                <email>gerson@nbsi.com.br</email>
                <fone>6521284300</fone>
            </infRespTec>
        </infNFe>
        <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
            <SignedInfo>
                <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
                <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
                <Reference URI="#NFe35191104952112000101550010001641221565130774">
                    <Transforms>
                        <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
                        <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
                    </Transforms>
                    <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
                    <DigestValue>WH7rPDLM73qwXpK6vXGYjscNlPc=</DigestValue>
                </Reference>
            </SignedInfo>
            <SignatureValue>AOUcYOnd0vasSjKSDUCumaoTEqBmTzrIRL5X/garDXN+A8iHNZTinZeoCR3ipAUIVXiLfos8XyJXuUNTrTFZ76dbpPnFwKJHkAdrKVR3T0fz8NOcpNC7flOW71IKq9ioQa4a9Qp+tmY7C1HGzlRC3t3TYP+n0TID69VBOPKIk9+wqHWYUkai3iG5Tb4rn9NyyeOJOtKL0AeFxrM0Uym42QmmIAwrjQUjg30K3otNeWUaLnggo9MKkZf3Fit97dLLd9seqEBiyeVcj/5JXTQAC6TVnH0Gqwoo0RCEejSxa/VH04LYbrCCi2ZxkCfaKevx34rZbe+WjZ19bGA8yfFTYw==</SignatureValue>
            <KeyInfo>
                <X509Data>
                    <X509Certificate>MIIHjTCCBXWgAwIBAgIIMg08RqB2MPAwDQYJKoZIhvcNAQELBQAwTDELMAkGA1UEBhMCQlIxEzARBgNVBAoMCklDUC1CcmFzaWwxKDAmBgNVBAMMH1NFUkFTQSBDZXJ0aWZpY2Fkb3JhIERpZ2l0YWwgdjUwHhcNMTkwMjIwMjIwMDAwWhcNMjAwMjIwMjIwMDAwWjCB2TELMAkGA1UEBhMCQlIxEzARBgNVBAoMCklDUC1CcmFzaWwxFDASBgNVBAsMCyhFTSBCUkFOQ08pMRgwFgYDVQQLDA8wMDAwMDEwMDg4NzAzNjQxFDASBgNVBAsMCyhFTSBCUkFOQ08pMRQwEgYDVQQLDAsoRU0gQlJBTkNPKTEUMBIGA1UECwwLKEVNIEJSQU5DTykxFDASBgNVBAsMCyhFTSBCUkFOQ08pMRQwEgYDVQQLDAsoRU0gQlJBTkNPKTEXMBUGA1UEAwwOQ0FMTU9UT1JTIExUREEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCHwmGXEfL3HW3qQHyXrN2lApzSgj0jG0uIE34gvGNKw+OOpA3C6+WyXWhQl+xEsvjvLLeCO+e8zbz/JP0NwylrL8z+jJwh7ZbVjZtulVK6VNneugKSkzWqvhqtMfaxgUTuIjyGPDeBqM6fL+GgqqlyMffmG+bK9qh+LLrn6PDkxCuUrJ7TEN8K7iipalmLSdSA24kfeqW0VAHIDm2zthJGRK7L2xy7K/xLghl/iKXtbCtJEfrit1Ej9Hf8RsIunEFLQIfaDycP44u8NjMfaKv+xPzrRv5RJ1zniWb6ZroIl6e+V1oz5cZTsPSrb6RUsSbL/m8Xd/CLykSFTz2+AIczAgMBAAGjggLjMIIC3zAfBgNVHSMEGDAWgBRWda9Kc7LYCMR9+2woHBHV98GozDCBlwYIKwYBBQUHAQEEgYowgYcwRwYIKwYBBQUHMAKGO2h0dHA6Ly93d3cuY2VydGlmaWNhZG9kaWdpdGFsLmNvbS5ici9jYWRlaWFzL3NlcmFzYWNkdjUucDdiMDwGCCsGAQUFBzABhjBodHRwOi8vb2NzcC5jZXJ0aWZpY2Fkb2RpZ2l0YWwuY29tLmJyL3NlcmFzYWNkdjUwgcIGA1UdEQSBujCBt4EcQUxFU1NBTkRST0BDQUxUQUJJQU5PLkNPTS5CUqA+BgVgTAEDBKA1EzMyMDExMTk3MDE2MjkwMjA2ODAwMDAwMDAwMDAwMDAwMDAwMDAwMjA5MzY0MjBTU1AgU1CgIwYFYEwBAwKgGhMYQUxFU1NBTkRSTyBQT1JURUxMQSBNQUlBoBkGBWBMAQMDoBATDjA0OTUyMTEyMDAwMTAxoBcGBWBMAQMHoA4TDDAwMDAwMDAwMDAwMDBxBgNVHSAEajBoMGYGBmBMAQIBBjBcMFoGCCsGAQUFBwIBFk5odHRwOi8vcHVibGljYWNhby5jZXJ0aWZpY2Fkb2RpZ2l0YWwuY29tLmJyL3JlcG9zaXRvcmlvL2RwYy9kZWNsYXJhY2FvLXNjZC5wZGYwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMEMIGbBgNVHR8EgZMwgZAwSaBHoEWGQ2h0dHA6Ly93d3cuY2VydGlmaWNhZG9kaWdpdGFsLmNvbS5ici9yZXBvc2l0b3Jpby9sY3Ivc2VyYXNhY2R2NS5jcmwwQ6BBoD+GPWh0dHA6Ly9sY3IuY2VydGlmaWNhZG9zLmNvbS5ici9yZXBvc2l0b3Jpby9sY3Ivc2VyYXNhY2R2NS5jcmwwHQYDVR0OBBYEFO1AGhpXWyfj3WdYRloXS2zem77tMA4GA1UdDwEB/wQEAwIF4DANBgkqhkiG9w0BAQsFAAOCAgEAjph8aYpzqKJUIomweFYjqZDpHjhq4Kq141n297Eb6St1Nj89aRllFKfhAPes5ZHJAVMUsx7hhWkqgZF1J2HUZnwP8jgWliqb/6rTs/L5XIOT2LIUftKt+4EdVcL7zSi0NpRzCBpuP5M9B5XXTTrgqOrbcgSSsxp700vP/hC1vmox9Qf5NFxxQ1RaEgmFSScCBBQPRmd1gw3+DiMlK5rVUE3mxJHPTISQSjsnDSEFOPIsdKQllUBckZI8uDQXSxQJ/ZNffXgdFY5vRb0R8jmMWebRP6HqvUZwY759oV8PaNiFHrpEOXRVD9J/LbQqQSkE76TKhF0gnMnSw8h3p98DSQRHCKPzY3frxabVrN2Ffrjk/GYuhu8vh17zA+k/e5RIvjR3M6Lw+LkWyjPcJ7adlTfkg+6oduTqgbuhazjcxfwTH/8xRwUNTlYK3ehgIxVTcNspvKc3WRdHxHQYprF8dydLouTJwPVwm5rqDTLLS8WxP2MXfthFSC1XOml+WcGbRlHcDNsqEIXw9Tg7S8ORHD6x7K5lDO/v366FIMq/ZZr3V5EzqbBH02zPMuyJw5b1vyaWsFvCFJw8QZevBjNeJGJaKbfccUdCEkdB5lLeIaHzSYdj1x0iiGgqFP7zXP0sTYOW6iqLqzM0otWqUavEblyCi3n/ZxMQEiS+zk5Do30=</X509Certificate>
                </X509Data>
            </KeyInfo>
        </Signature>
    </NFe>
    <protNFe versao="4.00">
        <infProt Id="Id135190852795161">
            <tpAmb>1</tpAmb>
            <verAplic>SP_NFE_PL009_V4</verAplic>
            <chNFe>35191104952112000101550010001641221565130774</chNFe>
            <dhRecbto>2019-11-14T15:23:14-03:00</dhRecbto>
            <nProt>135190852795161</nProt>
            <digVal>WH7rPDLM73qwXpK6vXGYjscNlPc=</digVal>
            <cStat>100</cStat>
            <xMotivo>Autorizado o uso da NF-e</xMotivo>
        </infProt>
    </protNFe>
</nfeProc>

Documento não encontrado

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"cnpjNumber":"04952112000101", 
	"nfeNumber":"000164122"
}

Relatórios

Aqui estão documentadas todas as nossas APIs públicas relacionadas aos relatórios

Get Report (obter relatórios)

O objetivo dessa API é obter um relatório personalizado no sistema a partir de um requisição do tipo REST.

GET https://vn.vianuvem.com.br/reports/api/report/schedulerReports/{ID relatório}/last

No "{ID relatório}" você deverá inserir o ID do relatório no sistema.

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorzation*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

{
    "id": 12451,
    "date": "29/10/2021 13:04:54",
    "storageLocal": "https://cdn.vianuvem.com.br/reports/scheduler_report/PkATkFFg7QVaRzL6jxOg.xlsx?Expires=1636318327&Signature=p4KAwm3HU6VzVQOAQQ8Q1LvTuh8NduAZmQrRh6fuKz2bh-UpXsG6-zC0ZABo9mJxAVZzV~uFmDQ4UxJKpz5kw88IS0GqEjnwFr~OZn92NmJu1Qany33NVEkuMz4U-IKarhqUlkJDGEYIurhQ6YNURRBaGkrBoEZRK7jI722xmpLzVj696znMz-RZRNBKWwdKNcgo37u~ydf2OATlo7zx25KHxWD4s8InECZn5z-V5BwD9PGPddClptQ5UUNBxgq4ABlDNXMATiIqZkT727NOiUXMHQHZOk1r74dnj4jX7HgWmXyv~bVq5SBXxToYSVHxHU5jqIeKWak2GZJcPHARLw__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA"
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Relatorio nao encontrado

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: suporte@vianuvem.com.br.

Gestão de usuários

Aqui estão documentadas todas as nossas APIs públicas relacionadas à gestão de usuários

Criar usuário

O objetivo dessa API é automatizar a criação de usuários no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/users/create

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name

Type

Description

name*

String

Nome do usuário

nickname*

String

Apelido do usuário

cpfNumber*

String

CPF do usuário

email*

Array de strings

E-mail do usuário

phone*

Array de strings

Telefone do usuário

nationality*

String

Nacionalidade do usuário

sex*

String

Sexo do usuário. M ou F

address*

String

Endereço do usuário. Pode ser vazio

addressComplement*

String

Complemento ao endereço. Pode ser vazio

addressNumber*

String

Número da casa do usuário. Pode ser vazio

neighborhood*

String

Bairro do usuário. Pode ser vazio

postalCode*

String

CEP do usuário. Pode ser vazio

city*

String

Cidade do usuário. Pode ser vazio

idState*

String

Estado do usuário. Pode ser vazio

birthday*

Data

Data de aniversário do usuário. Deve ser no formato "03/11/2021 10:37:28"

cnpj*

Array de strings

CNPJs que o usuário terá acesso no sistema

String

password*

String

Senha do usuário (com letra, número e caracter especial)

profiles*

Array de integer

Códigos dos perfis que o usuário terá acesso no sistema

{
    "userId": 50111289,
    "login": "INTEGRACAO.INTEGRACOES2",
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
    "redirectUrl": null
}

// CPF repetido ou usuário repetidos
Já existe um usuário com esse login

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{ 
      "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO 2",
      "nickName": "INTEGRAÇÃO",
      "cpfNumber": "38251883024",
      "email": ["email@email.com.br"], 
      "phone": ["11911112222"],
      "nationality": "Brasileiro", 
      "sex": "M",
      "address": "Rua Domingos de Moraes", 
      "addressComplement": "AP 21", 
      "addressNumber": 1000, 
      "neighborhood": "Vila Mariana", 
      "postalCode": "04150100", 
      "city": "São Paulo", 
      "idState": "SP",
      "birthday": "30/11/1990", 
      "cnpj": ["73386365000170"], 
      "login": "INTEGRACAO.INTEGRACOES3", 
      "password": "VIANUVEM", 
      "profiles": [12312]
}

Consultar usuário

O objetivo dessa API é automatizar a consulta de usuários no sistema a partir de uma requisição do tipo REST.

GET https://webservices.vianuvem.com.br/AdminVianuvem/api/users/byCPF/{cpf}

Um “route parameter” é enviado com o CPF do usuário a ser consultado.

Headers

Name

Type

Description

Content-Type*

String

application/json

Authorization*

String

Token de acesso adquirido através da API "Get JWT" (bearer)

{
    "name": "USUÁRIO CRIADO VIA INTEGRAÇÃO",
    "birthday": "30/11/1990",
    "sex": "M",
    "nickName": "INTEGRAÇÃO",
    "nationality": "Brasileiro",
    "cpfNumber": "18594015038",
    "email": [
        "email@email.com.br"
    ],
    "phone": [
        "null(11) 911112222"
    ],
    "login": "INTEGRACAO.INTEGRACOES",
    "postalCode": "04150100",
    "address": "Rua Domingos de Moraes",
    "addressNumber": "1000",
    "addressComplement": "AP 21",
    "neighborhood": "Vila Mariana",
    "idState": "SP",
    "city": "São Paulo",
    "profiles": [
        50029246,
        50030051
    ],
    "cnpj": [
        "73386365000170",
        "30092328000146"
    ]
}

Usuário não encontrado

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Desativar usuário

O objetivo dessa API é automatizar a desativação de usuários no sistema a partir de uma requisição do tipo REST.

DELETE https://webservices.vianuvem.com.br/AdminVianuvem/api/users/{login}/byLogin

Um “route parameter” é enviado com o nome do usuário a ser desativado.

Headers

Ativar usuário

O objetivo dessa API é automatizar a ativação de usuários no sistema a partir de uma requisição do tipo REST.

PUT https://webservices.vianuvem.com.br/AdminVianuvem/api/users{login)/byLogin

Um “route parameter” é enviado com o nome do usuário a ser ativado.