Advise Plataforma - Open API
APIs REST para a plataforma Advise.
Cada API da Advise fornece, de forma fácil e objetiva, seus métodos suportados, campos retornados, obrigatoriedade de informações, tal como suas situações e resultados.
Todas as APIs encontram-se divididas de acordo com a sua funcionalidade e métodos.
| Contato | |
| Telefone: (43) 3339-1000 | |
| Email: gislene.koyama@advise.com.br |
Navegação
A organização das pastas foi feita com a intenção de agrupar os assuntos em Documentação, Operações e Models.
Na pasta Documentação, irá constar as informações sobre a Empresa, manuais de utilização e informações mais genéricas.
Na pasta Models, irá constar os DTOs.
A pasta Operações está organizada em Assuntos\APIs\Rotas
Sempre que clicar em um Assunto, vai mostrar as regras e informações
- Ás páginas funcionam de forma sequencial, então conforme vai descendo a página irá mostrando os próximos assuntos e rotas.
Try It Out (Testar Rota)
Toda rota irá ter esse botão.
Na tela que abrir, selecionar os parâmetros em ‘Request Params’, conforme for marcando irá mostrando no lado esquerdo em Query Parameters.
Informar os parâmetros e clicar em SUBMIT.
Exemplo:
GET /webwooks/?campos=IdWebhook,IdCliente,Ativo, IdUsuarioInclusao, IdUsuarioUltAlteracao, DataHoraInclusao, DataHoraUltAlteracaoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
Request headers
Request body
objeto
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
{codEmenta}/download{codEmenta}/downloadPath variables
Usar codEmenta para buscar a jurisprudência que possui a ementa desejada.
Request headers
Token da aplicação
Responses
Request was successful
Body
Request parameters
- Termo desejado. Ex.: Danos morais;
- Necessário no minimo 3 letras.
Buscar ementa pedo código.
Ano em que a jurisprudencia foi disponibilizada.
- Data inicial do range
- Obrigatorio passar “dataFim”
- Data final do range
- Obrigatorio passar “dataInicio”
Número do recurso
Area. Ex.; Civil, Ambiental, etc.
Se possui arquivo de integra para baixar.
Sigla do tribunal
Nome ou parte do relator
Quantas registros virá na requisição
Pagina atual
Request headers
Token da aplicação
Responses
Request was successful
Body
{id}Exemplo:
POST /processos
{
"itens": [
{
"idUsuarioCliente": 51344,
"idUsuarioInclusao": 1,
"processos": [
{
"nomePasta": "Teste Nome Pasta",
"idSitPesqProcUsuarioCliente": 666,
"numeroProcesso": "0023382-29.2001.8.26.7155",
"FlNumUnicaCNJ" : true,
"fontesPesquisa": [
{
"idFonteXTipoPesquisa": 220,
"idValorParamFonteProc": 2308
}
]
}
]
}
]
}Request headers
Request body
objeto
{
"itens": [
{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}
]
}{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
{id}Path variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}{id}/marcar-lido{idPublicacaoCliente}/palavras-chaves{idPublicacaoCliente}/palavras-chaves/{id}{idPublicacaoCliente}/processos{idPublicacaoCliente}/processos/{id}Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}Path variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}/marcar-lidoEsta ação não requer o envio de nenhum dado.
Path variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{idPublicacaoCliente}/palavras-chavesPath variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{idPublicacaoCliente}/palavras-chaves/{id}Path variables
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{idPublicacaoCliente}/processosPath variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{idPublicacaoCliente}/processos/{id}Path variables
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
{IdPalavraChave}Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo:
GET /palavras-chaves/?campos=IdDiario,nomeUsuarioInclusaoRequest parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
{IdPalavraChave}Path variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Retorna a lista de objetos inseridos.
PUT /palavras-chaves/aprovar
body: { “ids”: [32,33] }
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
PUT /palavras-chaves/aprovar
"id": 32,
"motivo": Cancelei,
"idUsuarioCancelamento": 10Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
PUT /palavras-chaves/ativar
body: { “ids”: [32,33] }
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
PUT /palavras-chaves/inativar
body: { “ids”: [32,33] }
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo: /tipos-palavra-chave
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
PUT /palavras-chaves/desfazer-recusa
Este método retorna a situação da palavra chave para ‘Pendente’
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
PUT /palavras-chaves/desfazer-aprovacao
Este método retorna a situação da palavra chave para ‘Pendente’
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Usuario não logado ou inautorizado.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo: /situacoes-palavra-chave
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
{ids}/diarios-usuarios{id}{id}/diarios{id}/diarios/ativar{id}/diarios/inativar{ids}/diarios-usuariosPath variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna uma lista de erros padronizados com características da API solicitada.
Retorna a lista de objetos inseridos.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}Path variables
Request headers
Request body
Responses
Retorna a lista de objetos excluidos.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}/diariosPath variables
Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}/diarios/ativarPath variables
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
{id}/diarios/inativarPath variables
Request headers
Request body
Responses
Retorna a lista de objetos alterados.
Retorna uma lista de erros padronizados com características da API solicitada.
Exemplo:
Consulta a Clientes Partner Api
GET /v1/clientes
Retorna todos os Campos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&Campos=*
Buscar Clientes Específicos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&IDs=96771,2C96797&Campos=*
Buscar Campos Específicos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&Campos=pessoaCliente.nome%2C%20pessoaCliente.email&Expansao=pessoaCliente
Usando filtro específico (possíveis: nome, email, cpfcnpj, idplano, idcontrato, telefone)
/core/v1/clientes?Email=umnovoteste%40mailna.co&CPFCNPJ=83048590846&PaginaAtual=1&RegistrosPorPagina=10&Campos=*Request parameters
Request headers
Request body
Responses
Retorna a lista de objetos consultados.
Retorna uma lista de erros padronizados com características da API solicitada.
Usuario não logado ou inautorizado.
Exemplo:
Alteração de Clientes
Alterando Nome
PUT core/v1/clientes
}
"itens": [
{
"Id": 96837,
"pessoaCliente": {
"Id": 117934,
"nome": "Alterado API"
}
}
]
}
Outras Alterações
PUT core/v1/clientes
{
"itens": [
{
"Id": 96837,
"pessoaCliente": {
"Id": 117934,
"nome": "Alterado API",
"email": "alteradoapi@mailna.co",
"cpfcnpj": "48138896116",
"dataNascimentoAbertura": "",
"fone1": "",
"fone2": "",
"celular1": "",
"idSexo": -3,
"idTipoPessoa": -1,
"celular2": "",
"idUFMunicipio": "",
"idMunicipio": "",
"logradouro": "",
"numeroEndereco": "",
"complementoEndereco": "",
"cep": "",
"observacao": ""
}
}
]
}
Inativação e Ativação de Clientes
PUT core/v1/clientes/inativar
{
"iDs": [
96826,96837
]
}
PUT core/v1/clientes/ativar
{
"iDs": [
96826,96837
]
}Request parameters
Request headers
Request body
objeto