Ejemplos API REST DMDS v1 con nodejs
====================================

En este tutorial se van a mostrar diferentes ejemplos de como llamar la api rest del DMDS (Data-Mining and Delivery Services) con código de javascript, con la librería request de nodejs. Siempre tener en cuenta que método (GET, POST, DELETE, etc) se esta usando para cada llamada y cómo hacemos las llamadas, la parte de la uri.

Devuelve información de un contacto
-----------------------------------

En este ejemplo se va a explicar como devolver los grupos, eventos y campos de un contacto en concreto. En la llamada, en la url, hay que especificar el email del usuario ya existente en la base de datos de la api. Así de esta manera, se nos presentará todo la información de un contacto, como su nombre, apellido, etc. Aparte nos va a devolver a que grupos pertenece ese contacto y todos sus eventos.

.. code-block:: javascript

    var request = require('request');
    request.get({
        headers: {'content-type' : 'application/x-www-form-urlencoded',"Authorization":"xxxxxx"},
        url:     'https://api-dmds-host/v1/contacto/email',
        form:    {}
    }, function(error, response, body){
        console.log(body);
    });


Listar contactos inválidos
--------------------------

Con esta parte de código se nos va a mostrar todos los usuarios que han sido invalidados.

.. code-block:: javascript

    var request = require('request');
    request.get({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxx"},
       url:'https://api-dmds-host/v1/contactos/invalidos/',
       form: {}
    }, function(error, response, body){
      console.log(body);
    });

Crear nuevo o actualizar un contacto
------------------------------------


Con el siguiente parte de código se puede crear un contacto de nuevo o actualizar uno existente.La primera variable que se define es el correo electrónico, para entenderlo es como una primary key en la base de datos. Siempre para actualizar algún contacto nos basaremos en su email ya que es único.Podemos cambiar el grupo a que pertenece un  contacto, en la parte de grupos añadir otro nombre de grupo existente.También podemos cambiar su nombre, su apellido, etc. Todos los campos que se quieren cambiar.

.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxxxxxxx"},
       url:'https://api-dmds-host/v1/contacto/',
       form: {email:'xxxxxx@xxxx.com',grupos:'xxxxx',nombre:'xxxxxx',apellido:'xxxx',sexo:'x',edad:'xx',invalido:'0'}
    }, function(error, response, body){
       console.log(body);
    });


Invalidar un contacto
---------------------

En la misma actualización de un contacto, se puede invalidar o validar un contacto. Por defecto la variable invalido siempre está en cero. Pero en el caso que un usuario se quiere desuscribir o invalidar, poniendo esa variable a uno, (invalido: 1). Nos permite definir que este contacto esta en la lista de los inválidos.


.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxxxxxxx"},
       url:'https://api-dmds-host/v1/contacto/',
       form: {email:'xxxxxx@xxxx.com',grupos:'xxxxx',nombre:'xxxxxx',apellido:'xxxx',sexo:'x',edad:'xx',invalido:'1'}
    }, function(error, response, body){
      console.log(body);
    });

Enviar un correo
----------------

Para enviar un correo vamos a diferenciar los tipos que queremos enviar. Primero hay dos diferentes llamadas para enviar un correo a uno sólo destinatario y un correo a varios destinatarios. Para eso el cambio es muy básico, cambiar contacto por contactos. Otras dos llamadas se diferencian en enviar un html inline o un html mediante uri.Llamada genérica

.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxx"},
       url:'https://api-dmds-host/v1/envio/enviar/',
       form:'{"campana_id":"xxxxxxxxxxx","email":true,"contacto":{"email":"xxxxxxxx@xxxxxxx.com","nombre":"xxxx","apellido":"xxxxx"}}'
    }, function(error, response, body){ 
    console.log(body);
    });

Enviar un correo a un destinatario con html uri
-----------------------------------------------


Para realizar este envío es necesario definir algunos campos, como por ejemplo: el campo de email tiene que ser siempre verdadero, ya que esto nos permite enviar el correo. SI este valor esta en falso, no se podrán enviar mensajes. Otros valores a definir son la id de la campaña y el correo destinatario. Los otros valores como nombre, apellido, asunto son opcionales. En el caso que quiera enviar un html mediante uri, este se añade en la apartad de html_url. En el apartado de headers, recordar definir su valor de autorización.

.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxx"},
       url:'https://api-dmds-host/v1/envio/send_one_uri/',
      form: {"campana_id":"xxxxx","email":true,"contacto":{"email":"xxxx","nombre":"xxxx","apellido":"xxx"}, "html_url":"http://xxxxxx.html"}
    }, function(error, response, body){
    console.log(body);
    });

Enviar un correo a un destinatario con html inline
--------------------------------------------------

La diferencia de la llamada previa esta es como definir el html dentro del código. Hay dos maneras de enviar un correo con html inline.Una es definir el código html dentro del script:


.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxx"},
       url:'https://api-dmds-host/v1/envio/send_one_inline/',
       form: {"campana_id":"xxxxxx","email":true,"contacto":{"email":"xxxxx","nombre":"xxxxx","apellido":"xxx"}, "html":"<html><head><title>Page Title</title></head><body><h1>This is a Heading</h1><p>This is a paragraph.</p></body></html>"}
    }, function(error, response, body){
      console.log(body);
    });


Enviar un correo a más de un destinatario con html inline
---------------------------------------------------------

.. code-block:: javascript

    var request = require('request'); 
    request.post({ 
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxx"}, 
       url:'https://api-dmds-host/v1/envio/send_one_inline/',  
       form: {"campana_id":"xxxxxx","email":true,"contactos":{"email":"xxxxx","nombre":"xxxxx","apellido":"xxx"}, "html":"<html><head><title>Page Title</title></head><body><h1>This is a Heading</h1><p>This is a paragraph.</p></body></html>"} 
    },function(error, response, body) { 
       console.log(body); 
    });

Listar las variables globales y sus valores
-------------------------------------------

En la api hay definidas una serie de variables globales. Para ver cuales son estas variables y sus valores podemos ver el siguiente código.

.. code-block:: javascript

    var request = require('request');
    request.get({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxx"},
       url:'https://api-dmds-host/v1/global/',
       form: {}
    }, function(error, response, body){
       console.log(body);
    });

Crear variables globales
------------------------

Siempre podemos crear las variables globales. Para la creación vamos a usar el método post, donde le pasamos un variable, cual nos va a indicar el nombre de la variable global.

.. code-block:: javascript

    var request = require('request');
    request.post({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"APIKEYxxxxx"},
       url:'https://api-dmds-host/v1/global/',
       form: {"nombre":"loreispum", "valor":"hola"}
    }, function(error, response, body){
      console.log(body);
    });

Listar campañas
---------------

Con la misma estructura,  como listar los contactos inválido o listar las variables globales, podemos lista todas las campañas existentes. Para esto se utiliza el método get.

.. code-block:: javascript

    var request = require('request');
    request.get({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"xxxxxx"},
       url:'https://api-dmds-host/v1/campania/',
       form: {}
    }, function(error, response, body){
    console.log(body);
    });

Crear un grupo
--------------

Como hemos visto anteriormente, cuando creamos o modificamos un usuario podemos asignarle un grupo. Para poder asignar un grupo, hay que ver si este grupo existe, sino existe, podemos crearlo de la siguiente manera.

.. code-block:: javascript

    var request = require('request');
    request.post({
      headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"APIKEYxxxxx"},
      url:'https://api-dmds-host/v1/grupo/',
      form: {"nombre":"grupo_upf"}
    }, function(error, response, body){
    console.log(body);
    });

Listar los filtros
------------------

En el sistema de la api, se pueden crear diferentes filtros, que ayudan a especificar los envíos.Para ver esta lista de filtros existentes, seguimos el código mencionado abajo.


.. code-block:: javascript

    var request = require('request');
    request.get({
       headers: {'content-type' :'application/x-www-form-urlencoded',"Authorization":"APIKEYxxxxx"},
       url:'https://api-dmds-host/v1/filtros/',
       form: {}
    }, function(error, response, body){
    console.log(body);
    });

.. |date| date::

Last Updated on |date|