Integrator's Guide

Owned by OZmap
Last updated: Oct 02, 2024 by Leonardo Rosa Bittencourt
8 min read

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.

Process summary

In general, the recommendation when starting the integration process with OZmap is to contact our integration team, who will assist with any questions related to the OZmap API and provide access to the OZmap Sandbox for testing.

It is also recommended to review the OZmap API documentation to become familiar with its operation and define the integration features according to the instructions provided in this document.

OZmap Integration Team

The official contact with the integration team is made through the email address integracoes@ozmap.com.br. From this initial contact, we will arrange the creation of a WhatsApp group to expedite communications regarding the new integration.

Access to the OZmap Sandbox

When contacting the OZmap integration team, we can provide the credentials for accessing the OZmap Sandbox. In this environment, users are created with access to both the interface and the API.

Recommended Features

Below, we present a series of recommended features, ranging from basic to advanced, segmented according to the type of software you wish to integrate with OZmap. For a better understanding of some features, we would like to highlight that OZmap works with two types of elements that compose a client: the client element (which represents the person who contracted the service) and the property element (which represents the client’s residence, where the physical installation of the internet occurs). Therefore, in OZmap, a customer is generally represented as a combination of the customer element + property element.

Business Management (ERP)

 

  • 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.

    • 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.

    • 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.

    • 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.

    • Update Customer Optical Power - Update the current optical signal power (in dBm) of customers in OZmap.

    • Create Pendencies - Create pendencies in OZmap to represent network or customer adjustments and corrections.

Monitoring/Provisioning

Consultative Sales / Provider Query

Chatbot / IVR

CRM

Field Service

FAQ

Question

Answer

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.