Modelo de Autenticación

TABLA DE CONTENIDOS

  1. Relación Cliente - Servicio (ODC)
  2. Obtener Token
    1. Request
    2. Response
  3. Renovar un Token
    1. Request
    2. Response
  4. Realizar Consulta
    1. Request
    2. Response

Relación Cliente - Servicio (ODC)

Para utilizar los servicios provistos por nuestra plataforma, primero debe registrar un cliente y obtener los datos para la conxion, en especifico debe contar con un “Client ID” y “Secret Key” validos. Con estos datos podra conectarse para obtener un “Token” que le permitira ejecutar un Recolector realizando un llamado a la API de nuestro servicio.

Modelo de Autenticación

Es importante mencionar que los Tokens poseen un tiempo de expiracion, por lo que al realizar una consulta son automaticamente renovados. Para evitar la expiracion, usted puede renovar el token directamente cuando no este realizando consultas regularmente. De caso contrario el debera generar un nuevo token ejecutando el flujo completo de autenticacion.

Para ver ejemplos de integración con la API REST, revise nuestra sección de ejemplos.

Obtener Token

Servicio para la obtención del Token.

POST  https://opendatacollector.com/api/token/

Request

Parámetros de entrada:

Campo Tipo Descripción
grant_type String Valor ‘client_credentials’ por defecto para la obtención del token.
client_id String Id del cliente registrado.
client_secret String Key del cliente registrado.

Headers:

ID Valor
Content Type application/x-www-form-urlencoded
User Agent Especificación del agente del cliente.

Response

Ejemplo de respuesta del servicio:

{
  "access_token": "<TOKEN>",
  "expires_in": 3600
}

Atributos:

Campo Tipo Descripción
access_token String Token vigente para el acceso a la API.
expires_in Integer Tiempo de expiración del token medido en segundos.

Renovar un Token

Servicio que permite la solicitud de renovación para un token no vigente.

POST  https://opendatacollector.com/api/check/

Request

Parámetros de entrada:

Campo Tipo Descripción
access_token String Token a renovar.

Headers:

ID Valor
Content Type application/x-www-form-urlencoded
User Agent Especificación del agente del cliente.

Response

Ejemplo de respuesta del servicio:

{
"success": true,
"message": "Access Granted"
}

Atributos:

Campo Tipo Descripción
success Boolean Especifica mediante true o false el éxito de la transacción.
message String Mensaje de respuesta de la transacción.

Realizar Consulta

Servicio que ejecuta la consulta al ODC según el controller. Recuerde contar con créditos disponibles para realizar transacciones.

POST  https://opendatacollector.com/api/exec/<CONTROLLER>/<INPUT>/

Request

Parámetros de consulta:

Campo Tipo Descripción
CONTROLLER String Nombre del Collector a ejecutar.
INPUT String Parámetro de búsqueda del Collector.

Parámetros de entrada:

Campo Tipo Descripción
access_token String Token vigente.

Headers:

ID Valor
Content Type application/x-www-form-urlencoded
User Agent Especificación del agente del cliente.

Response

Ejemplo de respuesta del servicio:

{
  "success": true,
  "message": "Access Granted",
  "data": {
    "1539581302": {
      "version": 1539581302,
      "date": "2018-10-15 02:28:22",
      "source": "1522278887",
      "comments": "MERGE",
      "payload": {
        "plate": "CFZP61",
        "stolen": "FALSE"
      }
    }
  }
}

Atributos:

Campo Tipo Descripción
success Boolean Especifica mediante true o false el éxito de la transacción.
message String Mensaje de respuesta de la transacción.
data Object Objeto json con la respuesta del la consulta según el Collector.

OpenDataCollector © Xpertians - Desarrolladores - Soporte