API Rest (Portal Comercial)

Introdução

A API Pública permite que aplicações de terceiros estejam disponíveis no Portal Comercial para o uso das Revendas credenciadas na Intelidata. Este artigo vai explicar cada parte do processo, incluindo exemplos. Foi utilizado o aplicativo “Insomnia”, entretanto podem ser utilizadas outras ferramentas para acessar a API.

Gerando o token de acesso

O acesso seguro aos dados é baseado em um código de autorização: cada parceiro da Intelidata possui um código de autorização único (chamaremos aqui de token). Garanta que o token não fique visível e que pessoas mal-intencionadas não tenham acesso a esta informação.

A geração do token é feita no Portal Comercial no menu “Configuração da API”, conforme imagem abaixo:

Simplesmente clique no botão [Gerar token de acesso] para gerar um novo token e não esqueça de salvar. É uma boa prática renovar o token regularmente.

Endereço do servidor

Para ter acesso ao servidor da API, acesse: https://canal.intelidata.inf.br/public-api/

Para acessar a API basta informar no Header da requisição o parâmetro “token”. No valor, informe o token gerado no portal, conforme imagem a seguir:

Endpoints disponíveis e verbos

A API possui os seguintes endpoints:

 Endpoint n° 1

/public-api/bloquear-contrato/{cpfcnpj}

Verbo suportado: POST

Função: Esse endpoint serve para agendar o bloqueio de um contrato.

Irá seguir a mesma rotina de bloqueio via portal (será feito um agendamento para ser executado em 10 dias), porém será assumido um motivo de bloqueio padrão como “Bloqueio via API”.
O parâmetro {cpfcnpj} deve ser passado apenas com os números, sem incluir qualquer sinal de formatação.

Retorno:

Caso esteja tudo certo com a operação, será retornada a mensagem HTTP 200, com a data de agendamento do bloqueio.

Um e-mail avisando sobre o agendamento de bloqueio via API também será disparado:

Caso contrário, será retornada a mensagem informando o problema encontrado:

• A seguinte tela será retornada em casos de contratos com bloqueio já agendado:

• Contrato com apresentam agendamento de encerramento contarão como:

• Contrato não encontrado:

 Endpoint nº 2

/public-api/desbloquear-contrato/{cpfcnpj}

Verbo suportado: POST

Função: Esse endpoint serve para cancelar o agendamento ou desbloquear um contrato com o agendamento já executado.

O parâmetro {cpfcnpj} deve ser passado apenas com os números, sem incluir qualquer sinal de formatação.

Retorno:

Caso esteja tudo OK, haverá um retorno HTTP 200 com a mensagem de cancelamento de agendamento ou de desbloqueio do contrato.

Um e-mail avisando sobre o desbloqueio ou cancelamento do agendamento de bloqueio também é disparado:

Caso contrário, será retornada a mensagem com o problema encontrado:

• Agendamento inexistente:

• Contrato não encontrado:

• Contrato com agendamento de encerramento:

 Endpoint nº 3

/public-api/contratos

Verbo suportado: GET

Esse endpoint serve para listar todos os contratos abertos. São considerados contratos abertos os contratos com os status Aberto, Bloqueado e Degustação.

Retorno:

Array de objetos no formato JSON

 Endpoint nº 4

/public-api/contratos/{idStatus}

Verbo suportado: GET

Esse endpoint serve para listar os contratos com o status desejado. Nesse endpoint podem ser listados todos os tipos de status de contrato.

Retorno:

 Endpoint nº 5

/public-api/contrato/{cpfcnpj}

Verbo suportado: GET

Esse endpoint serve para consultar um contrato específicos do CPF/CNPJ informado.
Irá buscar o contrato aberto com o CPF/CNPJ (Aberto, Bloqueado ou Degustação)

Retorno:

 Endpoint nº 6

/public-api/contrato/{cpfcnpj}/{idStatus}

Verbo suportado: GET

Esse endpoint serve para consultar os contratos específicos do CPF/CNPJ informado.

Irá buscar o contrato com o status selecionado.

Retorno:

Objeto Contrato

Campo	Tipo	Observação
cpfCnpj	Caracter	CPF/CNPJ formatado
clienteFinal	Caracter	Razão social do cliente final do contrato
idStatus	Inteiro	id do status do contrato. Ids disponíveis: 1 – Aberto 2 – Encerrado 3 – Bloqueado 4 – Migrado 5 – Degustação 6 – Degustação encerrada
status	Caracter	O valor do status
descricaoStatus	Caracter	Descrição do status
versaoSistema	Caracter	Indica qual a versão do contrato
valortotal	Decimal	Valor total do contrato
dataCriacao	Data	Data que o contrato foi criado
usuarios	Inteiro	Quantidade de usuários do contrato
build	Caracter	Build atual do sistema
ultimoAcessoWs	Data/Hora	Data e hora do último acesso ao sistema
diasParaEncerrar	Inteiro	Quantidade de dias para o contrato ser encerrado (caso exista agendamento de encerramento)
dataEncerramento	Data	Data do encerramento do contrato
databloqueio	Data	Data do bloqueio do contrato
dataMigracao	Data	Data da migração do contrato
diasBloqueado	Inteiro	Quantidade de dias em que o contrato está bloqueado
diasParaBloqueio	Inteiro	Quantidade de dias para o contrato ser bloqueado (caso exista agendamento de bloqueio)
tipoLicenciamento	Caracter	Tipo de licenciamento do contrato (Novo combo ou Segmento)
tipoContrato	Caracter	Tipo de contrato (Desktop ou Web)

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda