Appearance

Consultas al API ​

Las consultas al API pueden tener operaciones como límites, paginación, búsqueda por campos, entre otras. Siguen las convenciones de mongoose-smart-query.

Filtro de campos ​

Usa la query string fields para seleccionar los campos a retornar. Múltiples campos se separan con espacio.

GET/v3/administrative/clients?fields=name email
TESThttps://api-test.upconta.com/v3/administrative/clients?fields=name email
PRODhttps://api.upconta.com/v3/administrative/clients?fields=name email

Para obtener todos los campos usa $getAllFields:

GET/v3/administrative/clients?$getAllFields=true
TESThttps://api-test.upconta.com/v3/administrative/clients?$getAllFields=true
PRODhttps://api.upconta.com/v3/administrative/clients?$getAllFields=true

Límites ​

Usa limit (valor por defecto: 20):

GET/v3/administrative/clients?limit=10
TESThttps://api-test.upconta.com/v3/administrative/clients?limit=10
PRODhttps://api.upconta.com/v3/administrative/clients?limit=10

Paginación ​

Usa page (valor por defecto: 1):

GET/v3/administrative/clients?page=3
TESThttps://api-test.upconta.com/v3/administrative/clients?page=3
PRODhttps://api.upconta.com/v3/administrative/clients?page=3

Límite y paginación suelen usarse juntos:

GET/v3/administrative/clients?limit=5&page=3
TESThttps://api-test.upconta.com/v3/administrative/clients?limit=5&page=3
PRODhttps://api.upconta.com/v3/administrative/clients?limit=5&page=3

Orden ​

Usa sort. Por defecto se ordena del más reciente al más antiguo.

  • Se ordena de menor a mayor. Para orden descendente usa el signo - antes del campo.
GET/v3/administrative/clients?sort=name
TESThttps://api-test.upconta.com/v3/administrative/clients?sort=name
PRODhttps://api.upconta.com/v3/administrative/clients?sort=name
GET/v3/administrative/clients?sort=-name
TESThttps://api-test.upconta.com/v3/administrative/clients?sort=-name
PRODhttps://api.upconta.com/v3/administrative/clients?sort=-name

Múltiples campos separados por espacio:

GET/v3/administrative/clients?sort=name -age
TESThttps://api-test.upconta.com/v3/administrative/clients?sort=name -age
PRODhttps://api.upconta.com/v3/administrative/clients?sort=name -age

Búsqueda ​

Usa q para buscar en campos configurados como buscables:

GET/v3/administrative/clients?q=nombre
TESThttps://api-test.upconta.com/v3/administrative/clients?q=nombre
PRODhttps://api.upconta.com/v3/administrative/clients?q=nombre

Para búsquedas exactas, especifica el campo:

GET/v3/administrative/[email protected]
TESThttps://api-test.upconta.com/v3/administrative/[email protected]
PRODhttps://api.upconta.com/v3/administrative/[email protected]

Para buscar texto incluido en un campo, usa {$includes}:

GET/v3/administrative/clients?email={$includes}ejemplo.com
TESThttps://api-test.upconta.com/v3/administrative/clients?email={$includes}ejemplo.com
PRODhttps://api.upconta.com/v3/administrative/clients?email={$includes}ejemplo.com

get-options ​

La mayoría de rutas tienen una subruta /get-options que retorna las opciones disponibles para los campos.

GET/v3/administrative/clients/get-options
TESThttps://api-test.upconta.com/v3/administrative/clients/get-options
PRODhttps://api.upconta.com/v3/administrative/clients/get-options
json
{
  "TiposDePersona": [
    { "id": "01", "description": "Persona natural" },
    { "id": "02", "description": "Sociedad" }
  ],
  "TiposDeIdentificacion": [
    { "id": "04", "description": "RUC" },
    { "id": "05", "description": "Cédula" },
    { "id": "06", "description": "Pasaporte" },
    { "id": "08", "description": "Identificación del exterior" },
    { "id": "09", "description": "Placa" }
  ]
}

Los id son los valores que pueden tomar ciertos campos.