Guía del integrador

¡Bienvenido, Integrador! Esta documentación es una guía destinada a facilitar el proceso de integración con OZmap desde el principio. Aquí encontrará instrucciones detalladas para ponerse en contacto con el equipo de integración de OZmap, solicitar acceso al Sandbox de OZmap para realizar pruebas y una lista completa de funciones recomendadas para cada tipo de software integrador, incluyendo tutoriales sobre cómo utilizarlas.

Inicio del proceso

En general, la recomendación a la hora de iniciar el proceso de integración con OZmap es contactar con nuestro equipo de integración, que le ayudará con cualquier duda relacionada con la API de OZmap y le proporcionará acceso a Sandbox de OZmap para realizar pruebas.

También se recomienda acceder a la documentación de la API de OZmap para familiarizarse con su funcionamiento y definir las funcionalidades de integración según las instrucciones proporcionadas en este documento.

Equipo de integración de OZmap

El contacto oficial con el equipo de integración se realiza a través del correo electrónico integracoes@ozmap.com.br. A partir de este contacto inicial, organizaremos la creación de un grupo de WhatsApp para agilizar las comunicaciones respecto a la nueva integración.

Acceso a Sandbox de OZmap

Poniéndote en contacto con el equipo de integración de OZmap, podremos proporcionarte las credenciales para acceder al Sandbox de OZmap. En este entorno se crean usuarios con acceso tanto a la interfaz como a la API, a la que se puede acceder a través de este enlace.

Funcionalidades indicadas

A continuación, te presentamos una serie de funcionalidades indicadas, desde las más básicas hasta las más avanzadas, segmentadas según el tipo de software que quieras integrar con OZmap. Para una mejor comprensión de algunas funcionalidades, destacamos que OZmap trabaja con dos tipos de elementos que componen un cliente: el elemento cliente (que representa a la persona que ha contratado el servicio) y el elemento inmueble (que representa la residencia del cliente, donde se realiza la instalación física de internet). Por tanto, en OZmap, un cliente se suele representar como un conjunto del elemento cliente

+ elemento inmueble.

ERP

Funcionalidades básicas
- Viabilidad técnica - Realizar una consulta en OZmap, pasando las coordenadas de un posible nuevo cliente, para recibir una lista de cajas o condominios con puertos disponibles para conectar al cliente en esta ubicación. Para realizar la búsqueda de factibilidad de cajas y condominios, será necesario utilizar dos solicitudes: Viabilidad por radio (o poste) y viabilidad de condominios.
  - API utilizada para la viabilidad por radio: https://ozmap.stoplight.io/docs/ozmap/8ffbbff600cd5-viabilidade-por-raio ;
  - API utilizada para viabilidad en condominios: https://ozmap.stoplight.io/docs/ozmap/05378a036dcc2-viabilidade-de-condominios ;
  - Descripción del uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/PD97zCxG ;
- Reserva de puertos - Crear un inmueble con un cliente no implantado en OZmap, representando un cliente que aún no ha sido instalado y esta esperando un puerto para cuando sea activado.
  - API utilizada para crear clientes: https://ozmap.stoplight.io/docs/ozmap/180b1534fb63f-cria-um-imovel ;
  - Descripción del uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/g3kyTUbL ;
- Implantación del cliente : actualizar el estado de implantación de un cliente de reserva de puerto a "implantado", convirtiendo esa reserva de puerto en un cliente final activado después de que se complete su instalación.
  - API utilizada para la implantación de clientes: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente ;
  - https://ozmap.atlassian.net/l/cp/rZK5r6FF
- Cancelación de reservas y clientes - Eliminar de OZmap un cliente de reserva de puerto o un cliente activo después de la cancelación de instalación o contrato en el sistema integrador.
  - https://ozmap.stoplight.io/docs/ozmap/86688c5b178ac-exclui-um-cliente
  - https://ozmap.atlassian.net/l/cp/377jZeur
- Cambio de domicilio - Realizar viabilidad técnica y reserva de puerto para la nueva dirección de un cliente que solicitó cambio de domicilio. Después de la activación del cliente en la nueva dirección, el cliente de OZmap con la dirección anterior es eliminado y el de la nueva dirección es implantado. Este proceso implica la ejecución de las funcionalidades de Viabilidad Técnica, Reserva de puertos y Implantación de clientes (nueva dirección) y Cancelación de reservas y clientes (antigua dirección).
- Actualización de caja del cliente - Actualizar la caja del cliente en OZmap, para situaciones donde la caja utilizada al momento de la instalación es diferente a la caja en la que se realizó la reserva de puerto del cliente. Para ello es necesario realizar una nueva viabilidad para encontrar los datos de la nueva caja a asignar al cliente.
  - API utilizada para actualizar caja del cliente: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel ;
Funcionalidades avanzadas
- Buscar splitter, caja y puerto del cliente - Buscar los datos de conexión del cliente en OZmap, es decir, caja, splitter y puerto donde está conectado actualmente. Para hacer esto, simplemente busque el inmueble del cliente en OZmap, pasando como un parámetro populate=box.
  - API utilizada para obtener datos de conexión del cliente: https://ozmap.stoplight.io/docs/ozmap/587e8a06c9f36-lista-os-imoveis ;
- Módulo OZloc para viabilidad y reserva de puertos - Utilice el módulo OZloc para realizar la viabilidad y reserva de puertos de forma sencilla, tanto por coordenadas como por dirección en texto, considerando todos los elementos de red disponibles para la conexión de red del cliente en OZmap, y apoyándose en diferentes métodos de viabilidad según configuraciones de OZmap, sin necesidad de solicitudes de API. Se puede iniciar pasando los datos del cliente por parámetro vía URL, o vía iframe para obtener como retorno los datos de la reserva creada en OZmap.
  - Descripción de uso de OZloc: OZloc ;
- Actualizar datos de clientes en OZmap - Actualizar datos generales de clientes en OZmap, como nombre, dirección, observaciones, coordenadas, entre otros. Como OZmap trabaja con conceptos de cliente e inmueble, parte de la información se actualiza en el elemento cliente y otras se actualiza en el elemento inmueble.
  - API utilizada para actualizar datos en el elemento cliente: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente ;
  - API utilizada para actualizar datos en el elemento inmueble: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel
- Actualización del estado del cliente : actualice el estado de los clientes en OZmap de acuerdo con su estado de conexión actual (online u offline, por ejemplo). Los estados disponibles actualmente son OK (icono de cliente verde en el mapa) o ERROR (icono rojo). Se utiliza principalmente para identificar problemas individuales y/o generales en los clientes de OZmap.
  - API utilizada para actualizar el estado del cliente: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/5uWdHXaP
- Actualización de potencia del cliente : actualice la potencia de lectura actual (señal óptica, en dbm) de los clientes en OZmap.
  - API utilizada para la actualización de potencia de los clientes: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/808wyvKC
- Creación de pendientes: crear pendientes en OZmap para representar puntos de ajuste y correcciones en la red o en los clientes.
  - API utilizada para crear pendientes: https://ozmap.stoplight.io/docs/ozmap/386d7cc17b6f0-cria-uma-pendencia

Monitoreo / Aprovisionamiento

Funcionalidades básicas
- Actualización del estado del cliente : actualizar el estado de los clientes en OZmap de acuerdo con su estado de conexión actual (online o offline, por ejemplo). Los estados disponibles actualmente son OK (icono de cliente verde en el mapa) o ERROR (icono rojo). Se utiliza principalmente para identificar problemas individuales o generales con clientes en OZmap.
  - API utilizada para actualizar el estado del cliente https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/5uWdHXaP
- Actualización de potencia del cliente : actualizar la potencia de lectura actual (señal óptica, en dbm) de los clientes en OZmap.
  - API utilizada para la actualización de potencia de los clientes: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/808wyvKC
Funcionalidades avanzadas
- Actualización de datos de ONUs - actualizar los datos de la ONU en el cliente OZmap, como la dirección mac, usuario pppoe y el número de serie.
  - API utilizada para actualizar los datos de ONU: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
- Actualización de potencia de puertos PON de OLTs : actualizar la potencia de salida de los puertos PON de OLTs(señal óptica, en dbm) en OZmap, para mejorar la precisión de la potencia calculada por proyecto en los elementos de red de OZmap.
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/MU231YLe
- Comparación de potencia leída x potencia calculada de los clientes: buscar la potencia calculada por proyecto dentro de OZmap y compárela con la potencia leída del cliente, lo que puede impedir el aprovisionamiento si la potencia de lectura es 2db peor que la potencia calculada de OZmap, por ejemplo.
  - API utilizada para buscar la potencia leída del cliente: https://ozmap.stoplight.io/docs/ozmap/ca6844631241a-dados-do-imovel-codigo-do-cliente
  - API utilizada para buscar la potencia calculada: https://ozmap.stoplight.io/docs/ozmap/173ab8b6726f6-imovel-olt-pop-codigo-do-cliente
- Consulta de CTOs, splitters y puertos disponibles para aprovisionamiento - Buscar en OZmap, para una determinada ubicación, cuales CTOs, splitters y puertos están disponibles para conectar un cliente. Para ello, es posible realizar una viabilidad, buscar los splitters de la caja elegida y comprobar qué puertos están disponibles (atributo output).
  - API utilizada para buscar cajas por ubicación: https://ozmap.stoplight.io/docs/ozmap/8ffbbff600cd5-viabilidade-por-raio
  - API utilizada para buscar splitters por caja: https://ozmap.stoplight.io/docs/ozmap/8337d3f9dc1c6-lista-os-splitters
- Creación de clientes : crear clientes en OZmap para cada ONU nueva aprovisionada en el sistema integrador, por ejemplo.
  - API utilizada para crear clientes: https://ozmap.stoplight.io/docs/ozmap/180b1534fb63f-cria-um-imovel
- Actualizar datos de clientes en OZmap - Actualizar datos generales de clientes en OZmap según información utilizada para el aprovisionamiento, como caja, puerto, splitter, coordenadas, entre otros. Como OZmap trabaja con conceptos de cliente e inmueble, parte de la información se actualiza en el elemento cliente y otra se actualiza en el elemento inmueble.
  - API utilizada para actualizar datos en el elemento cliente: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
  - API utilizada para actualizar datos en el elemento inmueble: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel
- Implantación de clientes : actualizar el estado de implantación de un cliente de reserva de puerto a "implantado", convirtiendo esta reserva de puerto en un cliente final activado después del aprovisionamiento de su ONU, por ejemplo.
  - API utilizada para la implantación de clientes: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/rZK5r6FF
- Cancelación de clientes : eliminar un cliente de OZmap después del desaprovisionamiento de su ONU, por ejemplo.
  - API utilizada para cancelamiento de clientes: https://ozmap.stoplight.io/docs/ozmap/86688c5b178ac-exclui-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/377jZeur

Venta consultiva / Consulta de proveedores

Funcionalidades básicas
- Viabilidad técnica - Realizar una consulta en OZmap, ingresando las coordenadas de un posible nuevo cliente, para recibir una lista de cajas o condominios con puertos disponibles para atenderlo en esta ubicación. Para realizar la búsqueda de viabilidad de cajas y condominios, será necesario utilizar dos solicitudes: viabilidad por radio (o poste) y viabilidad de condominios.
  - API utilizada para la viabilidad por radio: https://ozmap.stoplight.io/docs/ozmap/8ffbbff600cd5-radio-viability
  - API utilizada para la viabilidad en condominios: https://ozmap.stoplight.io/docs/ozmap/05378a036dcc2-viabilidade-de-condominios
  - Descripción de uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/PD97zCxG
Funcionalidades avanzadas
- Reserva de puertos - Crear un inmueble con un cliente no implantado en OZmap, representando un cliente que aún no ha sido instalado y se a reservado un puerto para cuando sea activado.
  - API utilizada para crear clientes: https://ozmap.stoplight.io/docs/ozmap/180b1534fb63f-cria-um-imovel
  - Descripción del uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/g3kyTUbL
- Creación de prospectos - Crear un prospecto en OZmap para registrar clientes que solicitaron servicio de internet pero que actualmente no cuentan con viabilidad técnica en su ubicación, por ejemplo.
  - API utilizada para crear prospectos: https://ozmap.stoplight.io/docs/ozmap/eeaee17d5416c-cria-um-prospect

Chatbot/URA

Funcionalidades básicas
- Viabilidad técnica - Realizar una consulta en OZmap, ingresando las coordenadas de un posible nuevo cliente, para recibir una lista de cajas o condominios con puertos disponibles para atenderlo en esta ubicación. Para realizar la búsqueda de viabilidad de cajas y condominios, será necesario utilizar dos solicitudes: viabilidad por radio (o poste) y viabilidad de condominios.
  - API utilizada para la viabilidad por radio: https://ozmap.stoplight.io/docs/ozmap/8ffbbff600cd5-radio-viability
  - API utilizada para viabilidad en condominios: https://ozmap.stoplight.io/docs/ozmap/05378a036dcc2-viabilidade-de-condominios
  - Descripción de uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/PD97zCxG https://ozmap.atlassian.net/l/cp/PD97zCxG
Funcionalidades avanzadas
- Reserva de puertos - Crear un inmueble con un cliente no implantado en OZmap, representando un cliente que aún no ha sido instalado y se a reservado un puerto para cuando sea activado.
  - API utilizada para crear clientes: https://ozmap.stoplight.io/docs/ozmap/180b1534fb63f-cria-um-imovel
  - Descripción del uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/g3kyTUbL
- Consulta de etiquetas : la consulta de etiquetas en OZmap se puede utilizar en varios contextos. Para un sistema URA, por ejemplo, se puede utilizar para identificar si un cliente que lo contactó está en un área con una caída masiva, para la debida advertencia sobre la situación del problema.
  - Descripción de uso por la API de OZmap: Falha/Queda Massiva
- Creación de prospectos - Crear un prospecto en OZmap para registrar clientes que solicitaron servicio de internet pero que actualmente no cuentan con viabilidad técnica en su ubicación, por ejemplo.
  - API utilizada para crear prospectos: https://ozmap.stoplight.io/docs/ozmap/eeaee17d5416c-cria-um-prospect

CRM

Funcionalidades básicas
- Viabilidad técnica - Realizar una consulta en OZmap, ingresando las coordenadas de un posible nuevo cliente, para recibir una lista de cajas o condominios con puertos disponibles para atenderlo en esta ubicación. Para realizar la búsqueda de viabilidad de cajas y condominios, será necesario utilizar dos solicitudes: Viabilidad por radio (o poste) y viabilidad de condominios.
  - API utilizada para la viabilidad por radio: https://ozmap.stoplight.io/docs/ozmap/8ffbbff600cd5-radio-viability
  - API utilizada para la viabilidad en condominios: https://ozmap.stoplight.io/docs/ozmap/05378a036dcc2-viabilidade-de-condominios
  - Descripción de uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/PD97zCxG
- Reserva de puertos - Crear un inmueble con un cliente no implantado en OZmap, representando un cliente que aún no ha sido instalado y se a reservado un puerto para cuando sea activado.
  - API utilizada para crear clientes: https://ozmap.stoplight.io/docs/ozmap/180b1534fb63f-cria-um-imovel
  - Descripción de uso de la API de OZmap: https://ozmap.atlassian.net/l/cp/g3kyTUbL
- Cancelación de reservas de puerto : eliminar de OZmap un cliente de reserva de puerto después de cancelar la orden de instalación.
  - API utilizada para cancelar reservas: https://ozmap.stoplight.io/docs/ozmap/86688c5b178ac-exclui-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/377jZeur
Funcionalidades avanzadas
- Implantación de clientes : actualizar el estado de implantación de un cliente de reserva de puerto a "implantado", convirtiendo esa reserva de puerto en un cliente final activado después de que se complete su instalación.
  - API utilizada para la implantación de clientes: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente
  - Descripción de uso por la API de OZmap: https://ozmap.atlassian.net/l/cp/rZK5r6FF
- Módulo OZloc para viabilidad y reserva de puertos - Utilizar el módulo OZloc para realizar la viabilidad y reserva de puertos de forma sencilla, tanto por coordenadas como por dirección de texto, considerando todos los elementos de red disponibles para la conexión de red del cliente en OZmap, y apoyándose en diferentes métodos de viabilidad según configuraciones de OZmap, sin necesidad de solicitudes de API. Se puede iniciar pasando los datos del cliente por parámetro vía URL, o vía iframe para obtener como retorno los datos de la reserva creada en OZmap.
  - Descripción uso de OZloc: OZloc ;
- Creación de prospectos - Crear un prospecto en OZmap para registrar clientes que solicitaron servicio de internet pero que actualmente no cuentan con factibilidad técnica en su ubicación, por ejemplo.
  - API utilizada para crear prospectos: https://ozmap.stoplight.io/docs/ozmap/eeaee17d5416c-cria-um-prospect

Otras funcionalidades

Sincronización de elementos : Buscar elementos en OZmap periódicamente para su creación, edición o eliminación en el sistema integrador. Esta búsqueda se puede realizar considerando fechas de creación, última actualización o fecha de eliminación de cada acción. El objetivo sería mantener una réplica de los elementos de red presentes en OZmap en la base del sistema integrador. Ejemplos de elementos que se podrían sincronizar son cajas, splitters, entre otros.
- API utilizada para buscar cajas: https://ozmap.stoplight.io/docs/ozmap/c7742f0fb1e29-lista-as-caixas ;
- API utilizada para buscar splitters: https://ozmap.stoplight.io/docs/ozmap/8337d3f9dc1c6-lista-os-splitters ;

Cuestionario

Pregunta	Respuesta
¿Están todas las funcionalidades de la API de OZmap disponibles en la documentación?	No, esta documentación es un trabajo en progreso, y si tiene una necesidad que no está cubierta en este documento o en la documentación de la API de OZmap, comuníquese con nuestro sector de integraciones para que podamos ayudarlo con su demanda.