API avanzada de Number Insight

Number Insight API le ofrece información en tiempo real sobre números de teléfono de todo el mundo. Hay tres niveles disponibles: Básico, Estándar y Avanzado.

El nivel Avanzado le proporciona los datos más completos para ayudarle a proteger su organización contra el fraude y el spam. A diferencia de los niveles Básico y Estándar, normalmente se accede a la API Avanzada de forma asíncrona, a través de un webhook.

En este tutorial

En este tutorial se crea un servicio web RESTful en Node.js y Express que acepta un número de teléfono y devuelve información detallada sobre el número cuando está disponible.

Para conseguirlo, sigue los siguientes pasos:

1. Crear el proyecto - crear una aplicación Node.js/Express.
2. Instale el vonage paquete - añade funciones de Vonage a tu proyecto.
3. Exponga su aplicación a Internet - uso ngrok para permitir que Vonage acceda a tu aplicación a través de un webhook.
4. Crear la aplicación básica - construir la funcionalidad básica.
5. Crear la solicitud asíncrona - llame a la API avanzada Number Insight.
6. Crear el webhook - escribir el código que procesa los datos insight entrantes.
7. Probar la aplicación - véalo en acción

Requisitos previos

Para completar el tutorial, necesitas:

• A Account de Vonage - para su clave y secreto API
• ngrok - para que tu servidor web de desarrollo sea accesible a los servidores de Vonage a través de Internet

Crear el proyecto

Crea un directorio para tu aplicación, cd en el directorio y, a continuación, utilice el gestor de paquetes de Node.js npm para crear un package.json para las dependencias de su aplicación:

Pulse [Intro] para aceptar cada uno de los valores predeterminados.

A continuación, instale el express marco de aplicaciones web y body-parser paquetes:

Instale el vonage paquete

Ejecute lo siguiente npm en la ventana de terminal para instalar el SDK de Vonage Node Server:

Exponga su aplicación a Internet

Cuando la API Number Insight termina de procesar su solicitud, avisa a su aplicación mediante un mensaje webhook. El webhook proporciona un mecanismo para que los servidores de Vonage se comuniquen con los tuyos.

Para que tu aplicación sea accesible para los servidores de Vonage, debe estar disponible públicamente en Internet. Una forma de lograr esto durante el desarrollo y las pruebas es utilizar ngrokServicio que expone los servidores locales a la Internet pública a través de túneles seguros. Véase esta entrada del blog para más detalles.

Descargar e instalar ngroke inícielo con el siguiente comando:

Esto crea URLs públicas (HTTP y HTTPS) para cualquier sitio web que se esté ejecutando en el puerto 5000 en su máquina local.

Utiliza el ngrok interfaz web en http://localhost:4040 y anote las URL que ngrok proporciona: los necesitas para completar este tutorial.

Crear la aplicación básica

Crear el index.js en su directorio de aplicaciones con el siguiente código, sustituyendo el archivo VONAGE_API_KEY, VONAGE_API_SECRET y WEBHOOK_URL con sus propios valores:

const app = require('express')();
const bodyParser = require('body-parser');

app.set('port', 5000));
app.use(bodyParser.json());

const VONAGE_API_KEY = // Your Vonage API key
const VONAGE_API_SECRET = // Your Vonage API secret
const WEBHOOK_URL = // e.g. https://bcac78a0.ngrok.io/webhooks/insight

app.get('/insight/:number', function(request, response) {
    console.log("Getting information for " + request.params.number);
}); 

app.listen(app.get('port'), function() {
    console.log('Listening on port', app.get('port'));
});

Pruébelo ejecutando el siguiente comando en el terminal y obteniendo el resultado que se muestra:

En un navegador, introduzca la siguiente URL, sustituyendo https://bcac78a0.ngrok.io con el nombre del host ngrok suministros:

https://bcac78a0.ngrok.io/insight/123456

Si todo funciona correctamente, Getting information for 123456 en el terminal.

Crear la solicitud asíncrona

Ahora que su aplicación puede recibir un número de teléfono, debe crear la solicitud asíncrona a la API asíncrona de Number Insight.

Primero, escribe el código que crea una instancia de Vonage con los datos de su Account:

const Vonage = require('@vonage/server-sdk');
const vonage = new Vonage({
    apiKey: VONAGE_API_KEY,
    apiSecret: VONAGE_API_SECRET
});

A continuación, amplíe el /insight/:number para llamar a la Number Insight API, introduciendo el número que le interesa y la URL del webhook que se ocupa de la respuesta. El webhook se crea en un paso posterior.

app.get('/insight/:number', function(request, response) {
    console.log("Getting information for " + request.params.number);
    nexmo.numberInsight.get({
        level: 'advancedAsync',
        number: request.params.number,
	callback: WEBHOOK_URL
    }, function (error, result) {
	if (error) {
	    console.error(error);
	} else {
	    console.log(result);
	}
    });
});

La llamada a la API avanzada de Number Insight devuelve una respuesta inmediata que confirma la solicitud antes de que los datos reales estén disponibles. Es esta respuesta la que registramos en la consola:

En status del cuerpo de la solicitud indica si la operación se ha realizado correctamente. Un valor cero indica éxito y un valor distinto de cero indica fallo, tal y como se describe en la sección Documentación de referencia de la API Number Insight.

Crear el webhook

La API Insight devuelve los resultados a su aplicación a través de un archivo POST por lo que debe definir el campo /webhooks/insight controlador de ruta como app.post()como se muestra:

app.post('/webhooks/insight', function (request, response) {
    console.dir(request.body);
    response.status(204).send();
});

El controlador registra los datos JSON entrantes en la consola y envía un mensaje 204 Respuesta HTTP a los servidores de Vonage.

Probar la aplicación

Ejecutar index.js:

Introduzca una URL con el siguiente formato en la barra de direcciones del navegador, sustituyendo https://bcac78a0.ngrok.io con su ngrok URL y INSIGHT_NUMBER con un número de teléfono de su elección:

http://YOUR_NGROK_HOSTNAME/insight/NUMBER

Tras la respuesta de acuse de recibo inicial, la consola debería mostrar información similar a la que se muestra a continuación:

Tenga en cuenta lo siguiente al probar su aplicación:

• La API Insight Advanced no proporciona ninguna información sobre teléfonos fijos que no esté disponible en la API Standard.
• Las solicitudes a la API Insight no son gratuitas. Considere la posibilidad de utilizar la ngrok salpicadero para reproducir solicitudes anteriores durante el desarrollo para evitar cargos innecesarios.

Conclusión

En este tutorial, ha creado una aplicación que utiliza la API asíncrona avanzada de Number Insight para devolver datos a un webhook.

El tutorial no cubría algunas de las funciones específicas de la API avanzada, como la coincidencia de direcciones IP, la accesibilidad y el estado de itinerancia. Revise la documentación para aprender a utilizar estas funciones.

¿Y ahora qué?

Los siguientes recursos le ayudarán a utilizar Number Insight en sus aplicaciones:

• En código fuente para este tutorial en GitHub
• Página de producto de Number Insight API
• Comparación de las API Insight básica, estándar y avanzada
• Guía de webhooks
• Referencia API avanzada de Number Insight
• Conecta tu servidor de desarrollo local a la API de Vonage mediante un túnel ngrok
• Más tutoriales