Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Documentación MeCubro v3.1 .es
Introduction
Inicio de sesión
Comunes
Aplicación
Públicos

Documentación MeCubro v3.1 .es

Esta colección le permite interactuar con nuestra API RESTFUL versión 3, para poder contratar seguros de accidentes personales a demanda. Las URL a utilizar son:

Para poder utilizarla debe cumplir los siguientes requisitos:

Requisitos

Un usuario registrado. El usuario es el que te permitirá validar tu identidad dentro de la plataforma utilizando un token de autenticación.

Una clave de aplicación asociada a tu usuario que podrás crear y consultar su código haciendo uso de la API. La aplicación es una entidad que utilizamos para identificar la unidad de negocio por medio del cual estás contratando los seguros. Cada aplicación cuenta con un número que la identifica, y es la que vamos a solicitarle en algunos recursos.

Filtros

Para los recursos que tengan habilitados los filtros de búsqueda se pueden utilizar estos operadores en conjunto con las columnas habilitadas para cada uno:

  • 'eq' => '=' // equal
  • 'ne' => '!=' // not equal
  • 'gt' => '>' // greater than
  • 'ge' => '>=' // greater than or equal
  • 'lt' => '<' // less than
  • 'le' => '<=' // less or equal
  • 'like' => 'LIKE'
  • 'notlike' => "NOT LIKE"
  • 'start' => 'LIKE'
  • 'end' => 'LIKE'
  • 'isnull' => 'IS NULL'
  • 'notnull' => 'IS NOT NULL'

En varios endpoints se dejará ejemplos de como utilizar los filtros.

  • Armado de URL:
    • ?filter[column][operator]=value;
    • ?filter[column][operator]=value&filter[column][operator]=value&filter[column][operator]=value;
  • Orden:
    • &sort_by=+column,-column2, Donde - es DESC y + es ASC
  • Limite:
    • &limit=10
  • Busqueda en más de una columna, mismo operador y mismo valor:
    • ?filter[column1,column2][operator]=value
  • Para filtrar relacionados.
    • ?filter[otroModelo.column][operator]=value&include=otroModelo
  • Función especial en los filtros:
    • Los signos ( | ) separan los campos con OR
    • Las comas ( , ) separar los campos con un AND
    • Los espacios son considerados como un caracter y toma como parte de la palabra.
    • No se pueden usar en conjunto
  • Un solo resultado:
    • ?first=true

Ejemplo:

/activities?page=2&sort_by=-name&filter[name][like]=ABOGADOS&filter[detail][like]=acróbata