Encontrack

Notification System - Auth

Descripción

Son los elementos responsables de implementar una capa de servicios mediante mecanismos de seguridad que de el acceso a nuestros clientes crear sus topicos.

Session

POST https://www.ens.eps-encontrack.com/api/rest/set_session/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "username": "",
  "password": "",
  "usuario": "",
  "clientes": [
    1,
    2
  ],
  "coberturas": [
    1,
    2
  ],
  "vehiculos": [
    1,
    2
  ],
  "valido_hasta": "2017-05-01 00:00:00"
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "tokenSession": "",
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errorIntegridad": "Universo de datos no autorizado en la integración.",
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Set
POST/api/rest/set_session/

Campos Requeridos username, password, usuario y valido_hasta

  • username (string requerido)

  • password (string requerido)

  • usuario (string requerido) - Ej: Lala

  • clientes ([int] )

  • coberturas ([int])

  • vehiculos ([int])

  • valido_hasta (datetime requerido)


Session Update

POST https://www.ens.eps-encontrack.com/api/rest/upd_session/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "username": "",
  "password": "",
  "tokenSession": "",
  "usuario": "",
  "clientes": [
    1,
    2
  ],
  "coberturas": [
    1,
    2
  ],
  "vehiculos": [
    1,
    2
  ],
  "valido_hasta": "2017-05-01 00:00:00"
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "tokenSession": "",
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errorIntegridad": "Universo de datos no autorizado en la integración.",
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Update
POST/api/rest/upd_session/

Campos Requeridos username, password, tokenSession, usuario y valido_hasta

  • username (string requerido)

  • password (string requerido)

  • usuario (string requerido)

  • tokenSession (string requerido)

  • clientes ([int] )

  • coberturas ([int])

  • vehiculos ([int])

  • valido_hasta (datetime requerido)


Session Close

POST https://www.ens.eps-encontrack.com/api/rest/close_session/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "username": "",
  "password": "",
  "tokenSession": ""
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "tokenSession": "",
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/jlson
Body
{
    "error": {
      "errorIntegridad": "tokenSession inválido para la integración.",
    },
    "status": "OK/UNAUTHORIZED",
}

Close
POST/api/rest/close_session/

Campos Requeridos username, password y tokenSession

  • username (string requerido)

  • password (string requerido)

  • tokenSession (string requerido)


Notification System - Topics

Descripción

Son los elementos responsables de implementar un sistema de creación y gestión de topicos, permitiendo un notificar mediante SMS, email y SNS a nuestros clientes eventos de importancia.

Create Topic

POST https://www.ens.eps-encontrack.com/api/rest/create_topic/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "nombre": "",
  "sms": true,
  "email": true,
  "eventos_detonantes": "700,701,702,703,704,705,706,707",
  "cercos_detonantes": "2,4",
  "dias_semana": "2,4",
  "horas_dia": "2,4",
  "mensajeNotificacion": "",
  "argumentos": "",
  "celulares": "+5214422107866,+5214422107866",
  "correos": "prueba@encontrack.com,notificacion@encontrack.com",
  "indeterminado": true,
  "fecha_inicio": "2017-05-01 00:00:00",
  "fecha_fin": "2017-05-01 00:00:00",
  "clientes": [
    1,
    2
  ],
  "coberturas": [
    1,
    2
  ],
  "vehiculos": [
    1,
    2
  ],
  "activo": false
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "id": 1,
      "nombre": "",
      "sms": true,
      "email": true,
      "eventos_detonantes": "700,701,702,703,704,705,706,707",
      "cercos_detonantes": "2,4",
      "dias_semana": "2,4",
      "horas_dia": "2,4",
      "mensajeNotificacion": "",
      "argumentos": "",
      "celulares": "+5214422107866,+5214422107866",
      "correos": "prueba@encontrack.com,notificacion@encontrack.com",
      "indeterminado": true,
      "fecha_inicio": "2017-05-01 00:00:00",
      "fecha_fin": "2017-05-01 00:00:00",
      "clientes": [1,2],
      "coberturas":[1,2],
      "vehiculos":[1,2],
      "activo": false,
    },
    "status": "OK/UNAUTHORIZED",
}

print an array with the errors “exceptions”

Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errorIntegridad": "Universo de datos no autorizado en la integración.",
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Create Topic
POST/api/rest/create_topic/

Campos Requeridos: tokenSession y nombre

description of this method

  • tokenSession (string requerido)

  • nombre (string requerido)

  • sms (boolean)

  • email (boolean)

  • eventos_detonantes (string) - (“701”,“702”) - (Separated Comma Integer List)

  • cercos_detonantes (string) - (“2”,“4”) - (Separated Comma Integer List)

  • dias_semana (string) - (“1”,“7”) - (Separated Comma Integer List)

  • horas_dia (string) - (“0”,“23”) - (Separated Comma Integer List)

  • mensajeNotificacion (string)

  • argumentos (string)

  • celulares (string) (Separated by Comma and with country code, ex: +5214422107866)

  • correos (string) (Separated by Comma)

  • indeterminado (boolean)

  • fecha_inicio (datetime)

  • fecha_fin (datetime)

  • clientes ([int])

  • coberturas ([int])

  • vehiculos ([int])

  • activo (boolean)


Edit Topic

POST https://www.ens.eps-encontrack.com/api/rest/edit_topic/TOPIC_ID/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "nombre": "",
  "sms": true,
  "email": true,
  "eventos_detonantes": "700,701,702,703,704,705,706,707",
  "cercos_detonantes": "2,4",
  "dias_semana": "2,4",
  "horas_dia": "2,4",
  "mensajeNotificacion": "",
  "argumentos": "",
  "celulares": "+5214422107866,+5214422107866",
  "correos": "prueba@encontrack.com,notificacion@encontrack.com",
  "indeterminado": true,
  "fecha_inicio": "2017-05-01 00:00:00",
  "fecha_fin": "2017-05-01 00:00:00",
  "clientes": [
    1,
    2
  ],
  "coberturas": [
    1,
    2
  ],
  "vehiculos": [
    1,
    2
  ],
  "activo": false
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "id": 1,
      "nombre": "",
      "sms": true,
      "email": true,
      "eventos_detonantes": "700,701,702,703,704,705,706,707",
      "cercos_detonantes": "2,4",
      "dias_semana": "2,4",
      "horas_dia": "2,4",
      "mensajeNotificacion": "",
      "argumentos": "",
      "celulares": "+5214422107866,+5214422107866",
      "correos": "prueba@encontrack.com,notificacion@encontrack.com",
      "indeterminado": true,
      "fecha_inicio": "2017-05-01 00:00:00",
      "fecha_fin": "2017-05-01 00:00:00",
      "clientes": [1,2],
      "coberturas":[1,2],
      "vehiculos":[1,2],
      "activo": false,
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errorIntegridad": "Universo de datos no autorizado en la integración.",
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Edit Topic
POST/api/rest/edit_topic/TOPIC_ID/

Campos Requeridos: tokenSession y nombre

description of this method

  • tokenSession (string requerido)

  • nombre (string requerido)

  • sms (boolean)

  • email (boolean)

  • eventos_detonantes (string) - (“701”,“702”) - (Separated Comma Integer List)

  • cercos_detonantes (string) - (“2”,“4”) - (Separated Comma Integer List)

  • dias_semana (string) - (“1”,“7”) - (Separated Comma Integer List)

  • horas_dia (string) - (“0”,“23”) - (Separated Comma Integer List)

  • mensajeNotificacion (string)

  • argumentos (string)

  • celulares (string) (Separated by Comma and with country code, ex: +5214422107866)

  • correos (string) (Separated by Comma)

  • indeterminado (boolean)

  • fecha_inicio (datetime)

  • fecha_fin (datetime)

  • clientes ([int])

  • coberturas ([int])

  • vehiculos ([int])

  • activo (boolean)


My Topics

POST https://www.ens.eps-encontrack.com/api/rest/my_topics/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": ""
}
Responses200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      {
          "id": 1,
          "nombre": "",
          "sms": true,
          "email": true,
          "eventos_detonantes": "700,701,702,703,704,705,706,707",
          "cercos_detonantes": "2,4",
          "dias_semana": "2,4",
          "horas_dia": "2,4",
          "mensajeNotificacion": "",
          "argumentos": "",
          "celulares": "+5214422107866,+5214422107866",
          "correos": "prueba@encontrack.com,notificacion@encontrack.com",
          "indeterminado": true,
          "fecha_inicio": "2017-05-01 00:00:00",
          "fecha_fin": "2017-05-01 00:00:00",
          "clientes": [1,2],
          "coberturas":[1,2],
          "vehiculos":[1,2],
          "activo": false
      },
      {
          "id": 1,
          "nombre": "",
          "sms": true,
          "email": true,
          "eventos_detonantes": "700,701,702,703,704,705,706,707",
          "cercos_detonantes": "2,4",
          "dias_semana": "2,4",
          "horas_dia": "2,4",
          "mensajeNotificacion": "",
          "argumentos": "",
          "celulares": "+5214422107866,+5214422107866",
          "correos": "prueba@encontrack.com,notificacion@encontrack.com",
          "indeterminado": true,
          "fecha_inicio": "2017-05-01 00:00:00",
          "fecha_fin": "2017-05-01 00:00:00",
          "clientes": [1,2],
          "coberturas":[1,2],
          "vehiculos":[1,2],
          "activo": false
      }
    },
    "status": "OK/UNAUTHORIZED",
}

My Topics
POST/api/rest/my_topics/

Campos Requeridos: tokenSession

  • tokenSession (string requerido)

Send Mail

POST https://www.ens.eps-encontrack.com/api/rest/send_mail/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "notificacion_subject": "",
  "notificacion": "",
  "correos": "prueba@encontrack.com,notificacion@encontrack.com",
  "link": ""
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "message": "Correo enviado",
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Send Mail
POST/api/rest/send_mail/

Campos Requeridos: tokenSession, correos, notificacion_subject y notificacion

description of this method

  • tokenSession (string requerido)

  • notificacion_subject (string requerido)

  • notificacion (string requerido)

  • correos (string) (Separated by Comma)

  • link (url)


Send SMS

POST https://www.ens.eps-encontrack.com/api/rest/send_sms/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "celulares": "+5214422107866,+5214422107866",
  "notificacion": "",
  "link": ""
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "message": "Mensaje enviado",
    },
    "status": "OK/UNAUTHORIZED",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errores": {
          "error1": "descripción"
      },
    },
    "status": "OK/UNAUTHORIZED",
}

Send SMS
POST/api/rest/send_sms/

Campos Requeridos: tokenSession, notificacion y celulares

description of this method

  • tokenSession (string requerido)

  • notificacion (string requerido)

  • celulares (string) (Separated by Comma and with country code, ex: +5214422107866)


Email Validation

Descripción

Son los elementos responsables de validar correos para evitar una suspensión de servicio por parte de los proveedores de envío de correo.

Verify Email

POST https://www.ens.eps-encontrack.com/api/rest/verify_email/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "email": "example@example.com"
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "message": "",
      "validation_response": ""
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "message": "",
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}

Verify Email
POST/api/rest/verify_email/

Campos Requeridos: email

description of this method

  • tokenSession (string requerido)

  • email (string)


AWS Connect

Descripción

Son los elementos responsables de realizar llamadas programadas a clientes con la finalidad de tener información extra de sus vehículos.

Flujo de Contacto Simple

POST https://www.ens.eps-encontrack.com/api/rest/contact_flow/simple/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "bienvenida": "Lorem ipsum",
  "numero": "+5214422111111",
  "opcion": "Lorem ipsum",
  "despedida": "Lorem ipsum"
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "message": "",
      "ContactID": ""
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errores": "",
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}

Flujo de Contacto Simple
POST/api/rest/contact_flow/simple/

Campos Requeridos: tokenSession, bienvenida, numero, opcion y despedida

description of this method

  • tokenSession (string requerido)

  • bienvenida (string requerido)

  • numero (string requerido)

  • opcion (string requerido)

  • despedida (string requerido)


Flujo de Contacto Complejo

POST https://www.ens.eps-encontrack.com/api/rest/contact_flow/complex/
Requestsexample 1
Headers
Content-Type: aplication/json
Body
{
  "tokenSession": "",
  "bienvenida": "Lorem ipsum",
  "numero": "+5214422111111",
  "opcion1": "Lorem ipsum",
  "opcion2": "Lorem ipsum",
  "despedida": "Lorem ipsum"
}
Responses200200
Headers
Content-Type: aplication/json
Body
{
    "data": {
      "message": "",
      "ContactID": ""
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}
Headers
Content-Type: aplication/json
Body
{
    "error": {
      "errores": "",
    },
    "status": "OK/UNAUTHORIZED/ERROR",
}

Flujo de Contacto Simple
POST/api/rest/contact_flow/complex/

Campos Requeridos: tokenSession, bienvenida, numero, opcion1, opcion2 y despedida

description of this method

  • tokenSession (string requerido)

  • bienvenida (string requerido)

  • numero (string requerido)

  • opcion1 (string requerido)

  • opcion2 (string requerido)

  • despedida (string requerido)


Generated by aglio on 13 Aug 2018