Welcome, Integrator! This documentation is a guide designed to facilitate the integration process with OZmap from the beginning. Here, you will find detailed instructions on how to contact the OZmap integration team, request access to the OZmap Sandbox for testing, and a list of recommended features for each type of integrating software, including usage tutorials.
...
Advanced Features
Search for Splitter, Box, and Port - Search OZmap for the customer’s connection data: the box, splitter, and port where they are currently connected. To do this, search for the customer’s property in OZmap, including the parameter
populate=box.API for searching customer connection data: https://ozmap.stoplight.io/docs/ozmap/587e8a06c9f36-lista-os-imoveis;
OZloc Module for Feasibility and Port Reservation - Use the OZloc module to perform feasibility and port reservations in a simple manner, both by coordinates and by text address, considering all available network elements for the customer’s network connection in OZmap, and utilizing different feasibility methods according to OZmap configurations, without the need for API requests. It can be initiated by inserting customer data via a URL parameter or via iframe to obtain the reservation data created in OZmap as a return.
OZloc usage description OZloc - English ver.
Update Customer Data in OZmap - Update general customer data in OZmap, such as name, address, notes, coordinates, etc. Since OZmap works with customer and property concepts, some information is updated in the customer element, and other information in the property element.
API for updating data in the customer element: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente;
API for updating data in the property element: https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel;
Update Customer Status - Update the status of customers in OZmap according to their current connection state (online or offline, for example). The available statuses are OK (green customer icon on the map) or ERROR (red icon). This is mainly used for identifying individual and/or general issues with customers in OZmap.
API for updating customer status: https://ozmap.stoplight.io/docs/ozmap/934d26a9b4202-atualiza-um-cliente;
API usage description Reading and updating a client status;
Update Customer Optical Power - Update the current optical signal power (in dBm) of customers in OZmap.
API for updating customer power:https://ozmap.stoplight.io/docs/ozmap/bad552b7cc42c-atualiza-um-imovel;
API usage description: Reading and updating the power at a client;
Create Pendencies - Create pendencies in OZmap to represent network or customer adjustments and corrections.
API for creating pendencies: https://ozmap.stoplight.io/docs/ozmap/386d7cc17b6f0-cria-uma-pendencia;
...
Element Synchronization – Periodically fetch elements from OZmap for creation, editing, or deletion in the integrator system. This fetch can consider creation dates, last update, or deletion dates for each action. The purpose is to maintain a replica of OZmap network elements in the integrator's database. Examples of elements for synchronization include distribution boxes, splitters, and others.
API used for box retrieval: https://ozmap.stoplight.io/docs/ozmap/c7742f0fb1e29-lista-as-caixas
API used for splitter retrieval: https://ozmap.stoplight.io/docs/ozmap/8337d3f9dc1c6-lista-os-splitters
...
FAQ
Question | Answer |
|---|---|
Are all the features of the OZmap API available in the documentation? | No, this documentation is a work in progress. If you have any needs not covered in this document or at OZmap API documentation, please contact our integrations team to assist with your request. |
...