API Reference

Métodos

Mais informações referente aos métodos disponíveis

Métodos HTTPS (RestAPI)

MétodosDescrição
[GET]- busca uma lista de registros - busca um registro em específico
[POST]- insere novos registros
[PATCH]- edita registros
[DELETE]- deleta registros

A maioria dos métodos [GET] recebe parâmetros opcionais na URL

ParâmetroObjetivo
id Código identificador do registro.
Deve ser utilizado quando se deseja obter um registro em específico.
page_sizeNúmero de registros por página.
mínimo – 1; máximo – 100; padrão - 15;
page_indexÍndice da página que se deseja retornar os registros.
O valor 0 representa a primeira página.
sort_fieldPermite escolher um campo para ordenar os resultados
sort_orderPermite escolher a ordenação ascendente ou descendente
Valores possíveis: asc ou desc; padrão - asc;
query Campo de texto para uma busca geral.
Exemplo: em contas a busca geral é aplicada sobre os campos nome, nome completo, e-mail principal e telefone principal.
filter Objeto JSON referente à uma busca e ordenação mais avançada.