¡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 al a Sandbox de OZmap para realizar pruebas.
...
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 ;
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.
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 OZlocpara 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
...