Advise Plataforma - Open API

Documentação
Advise Plataforma

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
Manual de Utilização da Documentação

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.

Operações

Métodos HTTPs permitidos:

GET
  • Método para consultar recursos do servidor.
POST
  • Método para inserir novos recursos.
PUT
  • Método para alterar recursos existentes.|
DELETE
  • Método para remover recursos do servidor.|
Webhook
GET /core/v1/webwooks
POST /core/v1/webwooks
PUT /core/v1/webwooks/inativar
Consulta uma lista de webhooks
GET /core/v1/webwooks

Exemplo:

GET /webwooks/?campos=IdWebhook,IdCliente,Ativo, IdUsuarioInclusao, IdUsuarioUltAlteracao, DataHoraInclusao, DataHoraUltAlteracao

Request parameters

IdsWebhook
array of integer optional
Collection format: multi
RotaApiCliente
string optional
Ativo
boolean optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordem
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Cria uma lista de webhooks
POST /core/v1/webwooks

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
rotaApiCliente
string
ativo
boolean

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

Altera uma lista de webhooks
PUT /core/v1/webwooks/inativar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Object
itens
Array
Object
idsWebhook
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Jurisprudência
GET /jurisprudencia/v1/jurisprudencia/{codEmenta}/download
GET /jurisprudencia/v1/jurisprudencia
GET /jurisprudencia/v1/relatores
Faz download da integra da ementa desejada
GET /jurisprudencia/v1/jurisprudencia/{codEmenta}/download

Path variables

codEmenta
string required

Usar codEmenta para buscar a jurisprudência que possui a ementa desejada.

Request headers

authorization
string optional

Token da aplicação

Responses

200 200

Request was successful

Body
string binary
Consulta uma lista de jurisprudências
GET /jurisprudencia/v1/jurisprudencia

Request parameters

termo
string optional
  • Termo desejado. Ex.: Danos morais;
  • Necessário no minimo 3 letras.
codEmenta
string optional

Buscar ementa pedo código.

ano
string optional

Ano em que a jurisprudencia foi disponibilizada.

dataInicio
string optional
  • Data inicial do range
  • Obrigatorio passar “dataFim”
dataFim
string optional
  • Data final do range
  • Obrigatorio passar “dataInicio”
numeroRecurso
string optional

Número do recurso

grupo
string optional

Area. Ex.; Civil, Ambiental, etc.

integra
boolean optional

Se possui arquivo de integra para baixar.

tribunal
string optional

Sigla do tribunal

relator
string optional

Nome ou parte do relator

registrosPorPagina
string optional

Quantas registros virá na requisição

paginaAtual
string optional

Pagina atual

Request headers

authorization
string optional

Token da aplicação

Responses

200 200

Request was successful

Body
Array
Object
codEmenta
number double
codBase
number double
ano
number double
codTribunal
number double
siglaTribunal
string
nomeTribunal
string
numeroEmenta
string
tipoRecurso
string
temIntegra
boolean
numeroRecurso
number double
numeroRecNForm
number double
uf
string
orgaoJulgador
string
grupo
Array of string
codRelator
number double
nomeRelator
string
dataPublicacao
string date-time
diario
string
pagina
number double
titulo
string
ementa
string
_version_
number double
id
number double
Consulta uma lista de relatores
GET /jurisprudencia/v1/relatores

Request parameters

nomeRelator
string optional

Nome ou parte do nome do relator

Request headers

authorization
string optional

Token da aplicação

Responses

200 200

Request was successful

Body
Object
nomeRelator
string
Processos
Processos de Clientes
POST /core/v1/processos-clientes
GET /core/v1/cabecalhos-processos
PUT /core/v1/processos-clientes/alterar-situacao
PUT /core/v1/processos-clientes/excluir-fonte
GET /core/v1/processos-clientes/dados-numero-processo
POST /core/v1/processos-clientes/dados-lista-numero-processo
GET /core/v1/anexo-fonte-processo/{id}
GET /core/v1/processos-clientes/processos-relacionados
PUT /core/v1/processos-clientes/marcar-lidos
PUT /core/v1/processos-clientes/desmarcar-lidos
Inserir lista de processos á serem pesquisados
POST /core/v1/processos-clientes

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

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Object
Default:
{
    "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": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
itens
Array
Object
Default:
{
    "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": ""
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
ativo
boolean
flPesqAndamentoAuto
boolean required
flPesqPublicacaoAuto
boolean required
idUsuarioClienteXFuncionalidade
integer int64 required
flDonoProcesso
boolean
idSitPesqProcUsuarioCliente
integer int64 required
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
processos
Array
Object
id
integer int64
numeroProcesso
string required
idTipoNumeroProcesso
integer int64
flNumUnicaCNJ
boolean required
solicPrimVezCliente
boolean
nomePasta
string
idSitPesqProcUsuarioCliente
integer int64
fontesPesquisa
Array
Object
id
integer int64 required
idProcesso
integer int64
idFonteXTipoPesquisa
integer int64
idValorParamFonteProc
integer int64
flSolicPorPublic
boolean required
ativo
boolean
clienteXFontePesqProcDTO
Array
Object
idCliente
integer int64 required
idFontePesqProcesso
integer int64 required
idLoteProcSpiderUltSuces
integer int64
idLoteProcSpiderUltAgend
integer int64
ativo
boolean
flSolicErroSpider
boolean
pesqProcUsuarioCliente
Array
Object
id
integer int64 required
idClienteXFontePesProc
integer int64 required
flPesqAndamentoAuto
boolean required
flPesqPublicacaoAuto
boolean required
idUsuarioClienteXFuncionalidade
integer int64 required
idSitPesqProcUsuarioCliente
integer int64 required
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioUltAlteracao
integer int64
dataHoraUltAlteracao
string date-time
dataHoraUltSolic
string date-time

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

Consulta a listagem de fontes dos processos associados ao usuário autenticado
GET /core/v1/processos-clientes/fontes-processos

Request parameters

IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
IdProcesso
integer int64 optional
IdsSituacoes
string optional
NumeroProcesso
string optional
IdOrgao
integer int64 optional
SiglaOrgao
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta uma lista de cabeçalhos de processos
GET /core/v1/cabecalhos-processos

Request parameters

IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
IdFonteProcesso
integer int64 optional
IdFontePesquisaProcesso
integer int64 optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de anexos de processos relacionadas ao usuário autenticado
POST /core/v1/processos-clientes/anexos

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
fontesProcesso
Array
Object
idFonteProcesso
integer int64
idProcesso
integer int64
idFonte
integer int64
idParametro
integer int64
trazerAnexosAndamento
boolean
pagina
integer int32
registrosPagina
integer int32
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

Altera a situação dos processos
PUT /core/v1/processos-clientes/alterar-situacao

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idGrupoUsuarios
integer int64
flAtivo
boolean
pesqProcAltSituacao
Array
Object
numeroProcesso
string
idFonteXTipoPesquisa
integer int64
idValorParamFonteProc
integer int64
idPesqProcUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Exclui processos
PUT /core/v1/processos-clientes/excluir-fonte

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idGrupoUsuarios
integer int64
fonteParamPesqProcesso
Array
Object
numeroProcesso
string
idFonteXTipoPesquisa
integer int64
idValorParamFonteProc
integer int64
idPesqProcUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Retorna dados do número do processo
GET /core/v1/processos-clientes/dados-numero-processo

Request parameters

NumeroProcesso
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Retorna dados de uma lista de números do processo
POST /core/v1/processos-clientes/dados-lista-numero-processo

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaNumeroProcesso
Array of string

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

Faz o download de um anexo
GET /core/v1/anexo-fonte-processo/{id}

Path variables

id
integer int64 required

Request parameters

idUsuarioCliente
integer int64 optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de andamentos de processos relacionadas ao usuário autenticado
GET /core/v1/processos-clientes/andamentos

Request parameters

IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
Lidos
boolean optional
DataInicial
string date-time optional
DataFinal
string date-time optional
IdProcesso
string optional
NumeroProcesso
string optional
FlTrazerAnexos
boolean optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de sujeitos de processos relacionadas ao usuário autenticado
GET /core/v1/processos-clientes/sujeitos

Request parameters

IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
IdProcesso
string optional
NumeroProcesso
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de informações adicionais de processos relacionadas ao usuário autenticado
GET /core/v1/processos-clientes/informacoes-adicionais

Request parameters

IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
IdProcesso
string optional
NumeroProcesso
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de processos relacionados a processos de um usuário autenticado
GET /core/v1/processos-clientes/processos-relacionados

Request parameters

IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdGrupoUsuarios
integer int64 optional
IdProcesso
string optional
NumeroProcesso
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Marca uma lista de processos como lida
PUT /core/v1/processos-clientes/marcar-lidos

Esta ação não requer o envio de id do usuario cliente, somente id do movimento.

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioCliente
integer int64 required
idGrupoUsuarios
integer int64
idMovProcessoCliente
integer int64 required
idUsuarioMovimento
integer int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Desmarcar uma lista de processos como lida
PUT /core/v1/processos-clientes/desmarcar-lidos

Esta ação não requer o envio de id do usuario cliente, somente id do movimento.

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioCliente
integer int64 required
idGrupoUsuarios
integer int64
idMovProcessoCliente
integer int64 required
idUsuarioMovimento
integer int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Publicações
Publicações de Clientes
GET /core/v1/publicacoes-clientes/{id}
PUT /core/v1/publicacoes-clientes/{id}/marcar-lido
PUT /core/v1/publicacoes-clientes/marcar-lidos
PUT /core/v1/publicacoes-clientes/desmarcar-lidos
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/palavras-chaves
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/palavras-chaves/{id}
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/processos
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/processos/{id}
Consulta a listagem de publicações relacionadas ao usuário autenticado
GET /core/v1/publicacoes-clientes

Request parameters

IdsProcessoPublicacao
string optional
IdsPublClientePalChave
string optional
DataInicioPublicacao
string date-time optional
DataFimPublicacao
string date-time optional
IdsDiarios
string optional
IdsPalavrasChaves
string optional
IdUsuarioCliente
integer int64 optional
IdCliente
integer int64 optional
Lido
boolean optional
DataInicioMovimento
string date-time optional
DataFimMovimento
string date-time optional
IdsCadernosDiarios
string optional
Id
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a publicação do cliente utilizando seu id
GET /core/v1/publicacoes-clientes/{id}

Path variables

id
integer int64 required

Request parameters

idClienteMovimento
integer int64 optional
idUsuarioClienteMovimento
integer int64 optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Marca a publicação como lida
PUT /core/v1/publicacoes-clientes/{id}/marcar-lido

Esta ação não requer o envio de nenhum dado.

Path variables

id
integer int64 required

Request parameters

idUsuarioClienteMovimento
integer int64 optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Marca uma lista de publicações como lida
PUT /core/v1/publicacoes-clientes/marcar-lidos

Esta ação não requer o envio de id do usuario cliente, somente id do movimento.

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioCliente
integer int64 required
idGrupoUsuarios
integer int64
idMovProcessoCliente
integer int64 required
idUsuarioMovimento
integer int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Desmarcar uma lista de publicações como lida
PUT /core/v1/publicacoes-clientes/desmarcar-lidos

Esta ação não requer o envio de id do usuario cliente, somente id do movimento.

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioCliente
integer int64 required
idGrupoUsuarios
integer int64
idMovProcessoCliente
integer int64 required
idUsuarioMovimento
integer int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta as palavras chaves da publicação
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/palavras-chaves

Path variables

idPublicacaoCliente
integer int64 required

Request parameters

IdPublicacaoCliente
string optional
Id
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a palavra chave relacionada a publicação utilizando seu id
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/palavras-chaves/{id}

Path variables

idPublicacaoCliente
integer int64 required
id
integer int64 required

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta os processos da publicação
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/processos

Path variables

idPublicacaoCliente
integer int64 required

Request parameters

IdPublicacaoCliente
string optional
Id
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta o processo relacionado a publicação utilizando seu id
GET /core/v1/publicacoes-clientes/{idPublicacaoCliente}/processos/{id}

Path variables

idPublicacaoCliente
integer int64 required
id
integer int64 required

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta a listagem de publicações relacionadas ao usuário autenticado Retorna dados de paginação
GET /core/v1/publicacoes-clientes/consulta-paginada

Request parameters

IdsProcessoPublicacao
string optional
IdsPublClientePalChave
string optional
DataInicioPublicacao
string date-time optional
DataFimPublicacao
string date-time optional
IdsDiarios
string optional
IdsPalavrasChaves
string optional
IdUsuarioCliente
integer int64 optional
IdCliente
integer int64 optional
Lido
boolean optional
DataInicioMovimento
string date-time optional
DataFimMovimento
string date-time optional
IdsCadernosDiarios
string optional
Id
string optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Palavras Chaves
Palavras Chaves
GET /core/v1/palavras-chaves
GET /core/v1/palavras-chaves/{IdPalavraChave}
PUT /core/v1/palavras-chaves
POST /core/v1/palavras-chaves
PUT /core/v1/palavras-chaves/aprovar
PUT /core/v1/palavras-chaves/reprovar
PUT /core/v1/palavras-chaves/ativar
PUT /core/v1/palavras-chaves/inativar
PalavraChaveClienteV1
GET /core/v1/palavra-chave-cliente/consultar
POST /core/v1/palavra-chave-cliente/inserir
PUT /core/v1/palavra-chave-cliente/alterar-situacao
PUT /core/v1/palavra-chave-cliente/alterar-situacao-variacao
PUT /core/v1/palavra-chave-cliente/atualizar
ApiV1PalavrachaveclienteConsultarGet
GET /core/v1/palavra-chave-cliente/consultar

Request parameters

IdCliente
integer int64 optional
IdPalavraChave
string optional
IdPalavraChavePrincipal
integer int64 optional
IdTipoPalavraChave
integer int64 optional
IdSituacaoPalavraChave
string optional
IdUsuarioClienteDono
integer int64 optional
FlPalavraChaveExata
boolean optional
NomePalavraChave
string optional
DataHoraInclusao
string date-time optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Limitado
boolean optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

ApiV1PalavrachaveclienteInserirPost
POST /core/v1/palavra-chave-cliente/inserir

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaPalavraChave
Array
Object
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
palavraChavePrincipal
string
idCliente
integer int64
idUsuarioCliente
integer int64
idGrupoUsuarios
integer int64
idSituacaoPalavraChave
integer int64

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

ApiV1PalavrachaveclienteAlterarsituacaoPut
PUT /core/v1/palavra-chave-cliente/alterar-situacao

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer int64
idSituacaoPalavraChave
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

ApiV1PalavrachaveclienteAlterarsituacaovariacaoPut
PUT /core/v1/palavra-chave-cliente/alterar-situacao-variacao

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer int64
flStatus
boolean

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

ApiV1PalavrachaveclienteAtualizarPut
PUT /core/v1/palavra-chave-cliente/atualizar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer int64
palavraChave
string
idTipoPalavraChave
integer int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta uma lista de palavras chaves
GET /core/v1/palavras-chaves

Exemplo:

GET /palavras-chaves/?campos=IdDiario,nomeUsuarioInclusao

Request parameters

DataInicio
string date-time optional
DataFim
string date-time optional
Cliente
integer int32 optional
UsuarioCliente
integer int32 optional
IdCliente
integer int32 optional
IdUsuarioCliente
integer int32 optional
IdsPalavraChavePrincipal
string optional
IdsTipoPalavraChave
string optional
Diario
integer int32 optional
Situacao
integer int32 optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Coluna
string optional
Ordem
string optional
Limitado
boolean optional
NomePalavraChave
string optional
IDs
string optional
Campos
string optional
Expansao
string optional
Q
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Consulta uma palavra chave utilizando o Id Palavra Chave
GET /core/v1/palavras-chaves/{IdPalavraChave}

Path variables

IdPalavraChave
integer int64 required

Request parameters

IDsPalavraChave
string optional
IdContrato
string optional
IdPlano
string optional
IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdsSituacaoPalavraChave
string optional
IdTipoPalavraChave
string optional
Ativo
boolean optional
NomePalavraChave
string optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Altera uma lista de palavras chaves
PUT /core/v1/palavras-chaves

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
palavraChave
string required
idTipoPalavraChave
integer int64
palavraChaveExata
boolean
idContrato
integer int64
idPlano
integer int64
usuariosCliente
Array
Object
idUsuarioClienteXPalChave
integer int64 required
idUsuarioClienteXFuncionalidade
integer int64
ativo
boolean
id
integer int64
vincularTodosDiarios
boolean
diarios
Array required
Object
idDiario
integer int64 required
ativo
boolean

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Cria uma lista de palavras chaves
POST /core/v1/palavras-chaves

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
palavraChave
string required
idTipoPalavraChave
integer int64 required
idPalavraChavePrincipal
integer int64
palavraChaveExata
boolean
ativo
boolean
idContrato
integer int64
idPlano
integer int64
usuariosCliente
Array
Object
id
integer int64
idUsuarioClienteXFuncionalidade
integer int64
ativo
boolean
vincularTodosDiarios
boolean
diarios
Array required
Object
idDiario
integer int64 required
ativo
boolean

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

201 201

Retorna a lista de objetos inseridos.

Aprova uma lista de palavras Chaves
PUT /core/v1/palavras-chaves/aprovar

PUT /palavras-chaves/aprovar

body: { “ids”: [32,33] }

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Reprova uma lista de palavras chaves
PUT /core/v1/palavras-chaves/reprovar

PUT /palavras-chaves/aprovar

 "id": 32,
 "motivo": Cancelei,
 "idUsuarioCancelamento": 10

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
id
integer int64
motivo
string
idUsuarioCancelamento
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Ativa uma lista de palavras chaves
PUT /core/v1/palavras-chaves/ativar

PUT /palavras-chaves/ativar

body: { “ids”: [32,33] }

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Inativa uma lista de palavras chaves
PUT /core/v1/palavras-chaves/inativar

PUT /palavras-chaves/inativar

body: { “ids”: [32,33] }

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Tipos de Palavras Chaves
GET /core/v1/tipos-palavra-chave
Consulta uma lista de tipos de palavras chave
GET /core/v1/tipos-palavra-chave

Exemplo: /tipos-palavra-chave

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Situações de Palavras Chaves
PUT /core/v1/palavras-chaves/desfazer-recusa
PUT /core/v1/palavras-chaves/desfazer-aprovacao
GET /core/v1/situacoes-palavra-chave
Desfaz reprovação da palavra chave
PUT /core/v1/palavras-chaves/desfazer-recusa

PUT /palavras-chaves/desfazer-recusa

Este método retorna a situação da palavra chave para ‘Pendente’

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Desfaz aprovação da palavra chave
PUT /core/v1/palavras-chaves/desfazer-aprovacao

PUT /palavras-chaves/desfazer-aprovacao

Este método retorna a situação da palavra chave para ‘Pendente’

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

401 401

Usuario não logado ou inautorizado.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta uma lista de situação de palavras chave
GET /core/v1/situacoes-palavra-chave

Exemplo: /situacoes-palavra-chave

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Palavras Chaves de Usuários Clientes
GET /core/v1/usuario-cliente-palavras-chaves/{ids}/diarios-usuarios
GET /core/v1/usuario-cliente-palavras-chaves
POST /core/v1/usuario-cliente-palavras-chaves
PUT /core/v1/usuario-cliente-palavras-chaves
PUT /core/v1/usuario-cliente-palavras-chaves/ativar
PUT /core/v1/usuario-cliente-palavras-chaves/inativar
DELETE /core/v1/usuario-cliente-palavras-chaves/{id}
GET /core/v1/usuario-cliente-palavras-chaves/{id}/diarios
PUT /core/v1/usuario-cliente-palavras-chaves/adicionar-diarios
PUT /core/v1/usuario-cliente-palavras-chaves/{id}/diarios/ativar
PUT /core/v1/usuario-cliente-palavras-chaves/{id}/diarios/inativar
Consulta uma lista de usuários cliente palavras chaves
GET /core/v1/usuario-cliente-palavras-chaves/{ids}/diarios-usuarios

Path variables

ids
string required

Request parameters

IDsUsarioClienteXPalChave
string optional
IDsUsarioClienteXDiario
string optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta uma lista de palavras chaves de usuários clientes
GET /core/v1/usuario-cliente-palavras-chaves

Request parameters

IDsPalavraChave
string optional
IdCliente
integer int64 optional
IdUsuarioCliente
integer int64 optional
IdsSituacaoPalavraChave
string optional
IdTipoPalavraChave
string optional
Ativo
boolean optional
NomePalavraChave
string optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Cria uma lista de palavras chaves de usuários clientes
POST /core/v1/usuario-cliente-palavras-chaves

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioClienteXDiario
integer int64
palavraChave
Object
id
integer int64
idClienteXDiario
integer int64
palavraChave
string required
idPalavraChave
integer int64
dataHoraInclusao
string date-time
idTipoPalavraChave
integer int64 required
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
idSituacaoPalavraChave
integer int64
nomePessoaCliente
string
idCliente
integer int64 required
nomePessoaUsuarioCliente
string
idUsuarioCliente
integer int64
nomePlano
string
idPlano
integer int64
nomeTipoPlano
string
idTipoPlano
integer int64
tipoPalavra
string
situacao
string
dataHoraUltAlteracao
string date-time
idContrato
integer int64
numeroContrato
string
idDiario
integer int64 required
nomeDiario
string
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
diasRetroativa
integer int64
flMigracao
boolean
nomePlanoBase
string
flAtivo
boolean
idUsuarioClienteXFuncionalidade
integer int64
flDonoPalavraChave
integer int64
vincularTodosDiarios
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioAlteracao
integer int64
dataHoraUlAlteracao
string date-time

Responses

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

201 201

Retorna a lista de objetos inseridos.

Altera uma lista de palavras chaves de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer int64
idUsuarioClienteXDiario
integer int64
palavraChave
Object
id
integer int64
idClienteXDiario
integer int64
palavraChave
string required
idPalavraChave
integer int64
dataHoraInclusao
string date-time
idTipoPalavraChave
integer int64 required
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer int64
idSituacaoPalavraChave
integer int64
nomePessoaCliente
string
idCliente
integer int64 required
nomePessoaUsuarioCliente
string
idUsuarioCliente
integer int64
nomePlano
string
idPlano
integer int64
nomeTipoPlano
string
idTipoPlano
integer int64
tipoPalavra
string
situacao
string
dataHoraUltAlteracao
string date-time
idContrato
integer int64
numeroContrato
string
idDiario
integer int64 required
nomeDiario
string
idUsuarioInclusao
integer int64
nomeUsuarioInclusao
string
idUsuarioUltAlteracao
integer int64
nomeUsuarioUltAlteracao
string
diasRetroativa
integer int64
flMigracao
boolean
nomePlanoBase
string
flAtivo
boolean
idUsuarioClienteXFuncionalidade
integer int64
flDonoPalavraChave
integer int64
vincularTodosDiarios
boolean
idUsuarioInclusao
integer int64
dataHoraInclusao
string date-time
idUsuarioAlteracao
integer int64
dataHoraUlAlteracao
string date-time

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Ativa uma lista de palavras chaves de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves/ativar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Inativa uma lista de palavras chaves de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves/inativar

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Remove uma lista de palavras chaves de usuário clientes
DELETE /core/v1/usuario-cliente-palavras-chaves/{id}

Path variables

id
integer int64 required

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos excluidos.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Consulta uma lista de diários vinculados em palavras chaves de usuários clientes
GET /core/v1/usuario-cliente-palavras-chaves/{id}/diarios

Path variables

id
integer int64 required

Request parameters

IDsUsuarioClienteXPalChave
string optional
IDsUsuarioClienteXDiario
string optional
Ativo
boolean optional
IDs
string optional
CodigosIDs
array of integer optional
Collection format: multi
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Ordenacao
string optional
Campos
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Vincula diários em palavras chaves de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves/adicionar-diarios

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Array
Object
idDiario
integer int64
idUsuarioClienteXPalChave
integer int64 required
vincularTodosDiarios
boolean
idUsuarioInclusao
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Ativa vínculo do diário com palavra chave de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves/{id}/diarios/ativar

Path variables

id
integer int64 required

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Inativa vínculo do diário com palavra chave de usuários clientes
PUT /core/v1/usuario-cliente-palavras-chaves/{id}/diarios/inativar

Path variables

id
integer int64 required

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer int64

Responses

200 200

Retorna a lista de objetos alterados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

Patner API

Documentação e Exemplos para Utilização de Apis pelos Parceiros

Clientes Partner Api
GET /core/v1/clientes
POST /core/v1/clientes
Consulta Clientes Api Partner
GET /core/v1/clientes

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

Nome
string optional
Email
string optional
CPFCNPJ
string optional
IdPlano
integer int64 optional
IdContrato
integer int64 optional
Telefone
string optional
Ativo
boolean optional
OrgaoPublico
boolean optional
UtilizaPerfil
boolean optional
PaginaAtual
integer int32 optional
RegistrosPorPagina
integer int32 optional
Coluna
string optional
Ordem
string optional
Limitado
boolean optional
PossuiContrato
boolean optional
PossuiUsuario
boolean optional
PossuiGrupo
boolean optional
IDs
string optional
Campos
string optional
Expansao
string optional
Q
string optional

Request headers

Authorization
string optional

Request body

Responses

200 200

Retorna a lista de objetos consultados.

400 400

Retorna uma lista de erros padronizados com características da API solicitada.

401 401

Usuario não logado ou inautorizado.

Alteração de Clientes Partner Api
PUT /core/v1/clientes

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

Campos
string optional

Request headers

Authorization
string optional

Request body

application/json-patch+json
application/json
text/json
application/*+json

objeto

Object
itens
Array
Object
id
integer int64 required