The integration with OZneutral serves two main purposes: providing your network information to verify feasibility within OZneutral, and creating or updating clients in OZmap who were sold through the system.
Procedure
Once the integration is active, OZneutral will start retrieving network information from the selected projects to assess the feasibility of the boxes. Only information about the available ports in each box will be accessible to the user in OZneutral.
It’s possible to configure which projects can be used for sales. This setup can be done both when adjusting the integration user’s permissions, by selecting access to specific projects, and directly within OZneutral.
The integration will also create users in OZmap for each partner whose partnership request is accepted, allowing the operator to optimize control during audits. The projects this user will have access to are defined at the moment the request is approved.
Features
The integration between the systems includes the following features
- Feasibility – Queries OZmap data to check sales availability at a specific location through OZneutral.
- Reservation – Start of the sales process. Once a port is reserved within OZneutral, a new client will be created in OZmap with the deployment status set to “not implanted”.
- Activation – As the installation process progresses, once the client becomes active in OZneutral, they will receive the deployment status 'implanted' in OZmap to indicate the completion of the sale.
- Cancellation – Cancellation can occur for both active and reserved clients, but in different ways. In the case of reservation cancellations, once the salesperson cancels the client in OZneutral, the client will be removed from OZmap immediately. For active client cancellations, when the port status in OZneutral changes to inactive, the client’s deployment status will revert to “not implanted”, and once the inspection is accepted, the client will be disconnected from OZmap and removed from the system.
Required data
To start the integration process, it is necessary to generate an API key from OZmap.
The user must have permission to access the projects that will be made available in OZneutral, as well as permission to access the API module, as shown in the example below.
The user information, password, and API key, as well as the URL of your OZmap, should be sent to the OZneutral team for the integration to be activated.