Introducción al Registro de la Red

Introducción

Las API de red están destinadas a empresas, no a particulares, aficionados o desarrolladores independientes. Por lo tanto, antes de realizar llamadas a las API de red, debes enviar el perfil de tu compañía para que los proveedores de servicios de comunicación (CSP) aprueben el acceso. Para agilizar este proceso, Vonage maneja el registro con varios CSP entre bastidores para todas las API de red admitidas en cualquier país donde estén disponibles los servicios de Vonage.

El proceso de aprobación consta de dos pasos:

1. Crear un perfil de empresa.

2. Cree un perfil de candidatura.

Ambos pasos pueden completarse utilizando el Registro de la red de Vonage, ya sea desde el panel o a través de la API.

Requisitos previos

Este tutorial asume que ya tienes una Account de Vonage. Si no tienes una, puedes crear una aquí.

Cuadro de mandos del Registro de la Red

Se puede acceder al registro de red a través del panel de control del usuario. Ingresa a tu cuenta de Vonage y, debajo de la imagen de tu avatar en el lado derecho del portal, haz clic en "Mi panel"." Utiliza el menú de navegación de la izquierda para localizar la sección Construir y administrar. Luego haz clic en Registro -> Registro de red.

Crear un perfil de empresa

El perfil empresarial incluye información legal sobre su empresa. Haga clic en "Añadir perfil de empresa" y rellene el formulario facilitando la siguiente información sobre su organización:

• País: dónde pueden acceder sus usuarios finales a sus aplicaciones.

• Función: su función en la organización.

• Nombre de la empresa: nombre de la entidad legal propietaria de las aplicaciones que usarán las API de la red de Vonage.

• Tipo de organización: seleccione el tipo más apropiado de la lista desplegable.

• Domicilio social/país: la dirección y el país donde está registrada su organización.

• Número de impuesto comercial: tu referencia fiscal utilizada por Vonage y sus CSP para validar tu organización.

• URL de la política de privacidad-Vonage y sus CSP exigen que cualquiera que utilice las API de red tenga una política de privacidad que esté disponible públicamente en Internet. Proporcione la URL de su política.

• Dirección de correo electrónico del responsable de la política de privacidad: incluya una dirección de correo electrónico que pueda utilizarse para cualquier pregunta sobre su política de privacidad.

• Dirección de correo electrónico del responsable de la protección de datos (RPD): sólo si la ley le obliga a tener uno.

New Business Profile

Después de enviar el formulario, verá un resumen de su perfil empresarial. Este resumen le ayudará a controlar el estado de su inscripción. Recibirá notificaciones por correo electrónico cuando cambie el estado de su inscripción.

Las respuestas de los CSP a las solicitudes de aprobación son asincrónicas y el Registro de la red de Vonage puede recibirlas en diferentes momentos.

Crear un perfil de solicitud

Los perfiles de Aplicaciones se utilizan para describir un caso de uso específico, incluyendo qué API de Red se requieren y el propósito para el que se utilizarán. Se compartirán con los CSP de los países incluidos en el perfil comercial asociado.

Vaya a la entrada Registro de red del menú de navegación izquierdo, haga clic en el nombre del perfil de la empresa y seleccione "Añadir perfil de aplicación". Aparecerá un formulario en el que tendrá que proporcionar más información sobre el tipo de aplicación que está creando:

• Nombre del perfil: asigne un nombre al perfil de su aplicación para facilitar su identificación.

• Categoría - Seleccione una categoría de aplicación de la lista desplegable.

• Ubicaciones de la infraestructura: especifique las ubicaciones de los países en los que puede procesar datos personales relacionados con el uso de las API de red solicitadas.

• APIs de red - Seleccione las APIs de red que desee utilizar.

• Finalidad - Para cada API de red seleccionada, confirme la finalidad en la lista desplegable, por ejemplo, "Prevención y detección de fraudes".

• Descripción del caso de uso: Describa su aplicación desde el punto de vista del consumidor.

New Application Profile

Tras el envío, recibirá un resumen de su solicitud de perfil. Se le enviarán notificaciones por correo electrónico cada vez que se produzca un cambio en el estado de su solicitud.

Seguimiento de mi presentación

Puede supervisar el estado del proceso de aprobación de su perfil de empresa. Vaya a la entrada Registro de la red en el menú de navegación de la izquierda y haga clic en su perfil empresarial. Aparecerá la página de resumen del perfil de empresa. Una vez allí, despliegue la entrada de perfiles de solicitud en la parte inferior de la página. Aparecerá una lista de CSP de los países que seleccionó durante la creación de su perfil de empresa, junto con sus estados de aprobación.

Network APIs Submission Status

API de registro de red

La API de registro de red permite a los desarrolladores enviar perfiles empresariales y de aplicaciones mediante programación. Esto resulta especialmente útil cuando diferentes equipos de su organización utilizan las API de red, lo que permite a cada equipo crear y utilizar perfiles de aplicación distintos según sea necesario a través de procesos internos.

Autenticación

Todas las llamadas a la API del Registro de la Red requieren autenticación para completarse. La autenticación se basa en la clave y el secreto de la API, que se pueden encontrar en la página de resumen de su panel de control y se enviarán dentro de la URL. se enviarán dentro de la URL.

API Key Secret

Advertencia: Tus credenciales API son secretas y sólo para uso personal. No las compartas con nadie.

Perfiles empresariales

El punto final /business-profile se utiliza para todas las operaciones del perfil empresarial: crear, recuperar, eliminar, etc.

Para crear un nuevo perfil de empresa, debemos enviar un mensaje POST . El cuerpo de la llamada contendrá la misma información solicitada por el cuadro de mandos del Registro de la Red (función, país, número de identificación fiscal, etc.).

El siguiente ejemplo utiliza cURL para crear un nuevo perfil de empresa llamado "Mi perfil de empresa", solicitando acceso a operadores de España y Alemania:

curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
  "contact_role":"developer",
  "name":"my business profile",
  "organisation_type":"forProfitOrganisation",
  "country":"ES",
  "tax_number":"1234567890",
  "privacy_policy_url":"https://1LThiQzd.com",
  "privacy_policy_manager_email":"manager@test.com",
  "dpo_email":"dpo@test.com",
  "dpo_required":true,
  "countries":[
    "ES",
    "DE"
  ],
  "business_information":{
    "address_street_1":"address 1",
    "address_street_2":"address 2",
    "city":"Madrid",
    "province":"Madrid",
    "postal_code":"28020",
    "country":"ES"
  },
  "email_notifications_enabled":true,
  "terms_and_conditions_accepted":true
}'

Podríamos enviar una solicitud GET para recuperar una lista de perfiles de empresa y controlar su estado:

curl "http://api-eu.vonage.com/v1/network-registry/business-profiles" -u ${API_Key}:${API_Password}

También es posible recuperar la información sobre el perfil empresarial de un determinado CSP enviando un comando GET al /business-profile/{id}/csps punto final:

curl "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/csps" -u ${API_Key}:${API_Password}

En caso de que queramos modificar un perfil de empresa, podríamos enviar una solicitud PUT a /change-request

curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/change-request" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "countries": [
      "ES"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organisation_type": "For-Profit Organisation",
   "tax_number": "98284687G",
   "privacy_policy_url": "https://www.businessinc.com/privacy_policy",
   "privacy_policy_manager_email": "privacy.manager@business.com",
   "dpo_email": "dpo@business.com",
   "dpo_required": true,
   "terms_and_conditions_accepted": true,
   "business_information": {
      "address_street_1": "Main Street 5",
      "address_street_2": "Extra long address",
      "postal_code": "W1 5DU",
      "country": "UK",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true
}'

Por último, podemos eliminar un perfil empresarial existente ejecutando este comando:

curl -X DELETE "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123

Perfil de las Applications

De forma similar a los perfiles de empresa, podemos utilizar el endpoint /application-profiles para realizar todas las operaciones relacionadas con los perfiles de aplicación.

El siguiente ejemplo envía una petición POST para crear un nuevo perfil de aplicación:

curl -X POST "http://api-eu.vonage.com/v1/network-registry/application-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
   "business_profile_id": "string",
   "name": "Network Application Profile",
   "description": "This is an example use case for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
}'

Podríamos recuperar una lista de perfiles de aplicaciones enviando una petición GET. Podríamos filtrar el resultado enviando parámetros de consulta como estado (pendiente, aceptado, rechazado, etc.) o business_profile_idpara obtener los perfiles de solicitud de un perfil de empresa específico.

curl "http://api-eu.vonage.com/v1/network-registry/application-profiles" -u ${API_Key}:${API_Password}

El sitio Referencia API contiene una descripción detallada del resto de operaciones.

Más operaciones

Más allá de las operaciones para gestionar perfiles de empresa y de aplicación, la API del Registro de Red proporciona puntos finales útiles para operar con otros recursos, como países, API de red compatibles o tipos de organización.

Para obtener una lista de los países admitidos, podríamos enviar una solicitud GET como la de este ejemplo:

curl "http://api-eu.vonage.com/v1/network-registry/catalogue/countries" -u ${API_Key}:${API_Password}

Del mismo modo, enviando una solicitud GET a la dirección /network-api podemos obtener una lista de las API de red compatibles:

curl "http://api-eu.vonage.com/v1/network-registry/catalogue/network-apis" -u ${API_Key}:${API_Password}

El catálogo sección de la Referencia API contiene una lista de recursos a los que se puede acceder a través de /catálogo endpoint.

¿Y ahora qué?

Una vez que tu envío es aprobado por al menos uno de sus CSP, puedes vincularlo a una o más aplicaciones de Vonage para comenzar a usar las API de red. La aplicación de Vonage contiene las credenciales necesarias para realizar llamadas API.

Ponte en contacto

¡Nos encantaría saber de ti! Únete a la canal Slack de la comunidad de Vonage para compartir tus experiencias con el Registro de red. También puedes seguir al equipo de Vonage Developer Experience en Xantes conocido como Twitter.