Neste site demonstramos as funcionalidades da API WXEQ, dentre elas, autenticação, paginação, consulta com filtro, inserção e alteração de dados.

O resultado da busca conterá no seu cabeçalho:

• X-Pagination-Total-Count: Total de registros
• X-Pagination-Page-Count: Total de páginas
• X-Pagination-Current-Page: Índice da página atual
• X-Pagination-Per-Page: Quantidade de registros por página

É possível definir qual o índice da página e quantidade de registros por página devem ser retornandos.

• page: Índice da página
• per-page: Quantidade de registros por página

Exemplo:

http://api.wxeq.com.br/v1/trajeto?page=2&per-page=30

Em todas as requisições de listagem de dados é possível definir um filtro

{
  "or": [
    {
      "and": [
        {"descricao": "alguma descricao"},
        {"preco": 25.50}
      ]
    }, {
      "id": {"in": [2, 5, 9]},
      "preco": {"gt": 10, "lt": 50}
    }
  ]
}

Os possíveis operadores são:

• lt: <
• gt: >
• lte: <=
• gte: >=
• eq: =
• neq: diferente
• in: contido
• nin: não está contido
• like: contendo

Exemplo:

http://api.wxeq.com.br/v1/trajeto?filtro={"id": {"in": [1]}}

Em todas as requisições de listagem de dados é possível definir uma totalização sumário

[{
    selector: "numero",
    summaryType: "count"
  },
  {
    selector: "qtd",
    summaryType: "sum"
}]

Exemplo:

http://api.wxeq.com.br/v1/trajeto?totalSummary=[{selector: "numero",summaryType: "count"}]

Obtem informações do login.

No retorno conterá o campo token que deverá ser utilizado nas demais requisições como método de autenticação.

Os seguintes métodos de autenticação estão disponíveis:

• JWT Tokens (Adicionar o Header Authentication com o valor Jwt <TOKEN>)
• Chave API - Inativo
• Basic Authentication - Inativo

Todas requisições deverão conter o token utilizando um método de autenticação