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)

 

Monitoring/Provisioning

Consultative Sales / Provider Query

Chatbot / IVR

  • Basic features

    • Technical Feasibility – Perform a query in OZmap by inputting the coordinates of a potential new client to receive a list of distribution boxes or buildings with available ports to serve the client at this location. To assess feasibility by searching for boxes and buildings, two requests are needed: Feasibility by radius (or pole) and Feasibility of buildings.

  • Advanced Features

CRM

  • Basic features

    • Technical Feasibility – Perform a query in OZmap by inputting the coordinates of a potential new client to receive a list of distribution boxes or buildings with available ports to serve the client at this location. To assess feasibility by searching for boxes and buildings, two requests are needed: Feasibility by radius (or pole) and Feasibility of buildings.

    • Port Reservation – Create a property for a client not yet installed in OZmap, representing a client who has not been activated, reserving a port for future activation.

    • API used for client creation: Create a property | OZmap

    • API usage description in OZmap: Port reservation

    • Port Reservation Cancellation – Remove a client from OZmap's port reservation after the installation request is canceled.

  • Advanced Features

    • Client Implantation – Update the deployment status of a port reservation client to "Implanted," converting this port reservation into an activated client after installation is completed.

    • OZloc Module for Feasibility and Port Reservation – Use the OZloc module to perform feasibility checks and port reservations easily, either by coordinates or text address, considering all available network elements for client connection in OZmap. It supports different feasibility methods according to OZmap settings, without needing API requests. It can be initiated by passing client data via URL parameters or using an iframe to receive the created reservation data from OZmap as a return.

    • Prospect Creation – Create a prospect in OZmap to record clients who requested internet service but currently lack technical feasibility at their location.

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.