Help Center

English

Português
Español

English

Português
Español

Appearance

API Clients ​

Introduction ​

The IXC ACS API Clientallows integrating the platform intoexternal systems** such as ERPs, enabling automations and information exchange.

In addition to generic integration, there is also a specific integration with the IXC Provider, focused on the most common flows, allowing the sending of data such as PPPoE and Wi-Fi information.

After registration and completion of integration, communication between systems occurs automatically.

Example

What is an API Client?

API (Application Programming Interface) is a set of rules that allows systems to communicate automatically. In the IXC ACS, the API Client represents this “bridge” of communication between ACS and other systems, such as ERPs, external platforms or IXC Provider himself.

Attention

For the integration with the IXC Provider, it is important to highlight that the registration of the API Client in the IXC CHA is only the first stage of the process**. Other settings are needed for integration to work properly.

Access to functionality

Path: Tools Menu > API Clients > New API Client

Settings ​

When accessing the option New API Client, a configuration modal where you define how IXC ACS will communicate with another system will be displayed. API Client Integration Types At this stage, you define which system the ACS will integrate with**. Currently, there are two types of integration available:

1. ​

Used when the IXC ACS will be integrated into third party systems (except IXC Provider), such as ERPs or external platforms. In this model, the external system will be responsible for consuming the ACS API and receiving the configured webhooks.

  • Before step by step, see below the fields used in creating the generic API Client:*

Field

Name Token expiation After this period, you will need to generate a new token to continue using the API Requests per minute Requests per day

Invalid certificate Webhooks issued The webhooks represent events that the ACS automatically sends to the external system when something happens. Examples: • device added or removed • change of device parameters • reset or reset • End of diagnosis

For example:

if a reboot is requested via API, when the device restarts, the ACS will send a webhook notifying the external system. The same view applies to other events.

Selecting only the necessary events helps reduce traffic and make integration more efficient. Generic API Client Integration Configuration

  1. In modal Create API Client, select type Generic

  2. Fill in the identification name

  3. Set the token expiration time

  4. Set request limits per minute and per day

  5. Activate webhook and report external system URL • If the URL uses invalid SSL certificate, enable the option Invalid certificate

  6. Select the webhooks that will be issued

  7. Click Create API Client

After creation, you can edit the API Client and define its permissions. For this, click on the three points to the right of the created client and adjust which API features it can access.

2. IXC Provider ​

Integration with IXC Provider requires configurations in IXC ACS and IXC Provider, carried out together. ######## In the IXC ACS

  1. In modal Create API Client, select type IXC Provider

  2. In Name, please inform something that clearly identifies integration, for example: Integration IXC Provider

  3. In the field Public key, you will need to paste the key that will be generated in the IXC Provider (see steps below)

######## In the IXC Ombudsman

  1. Access Menu System > Provider > ACS > Integrations

  2. Click New

  3. Select option IXC ACS

  4. On behalf, inform a CHA identifier

  5. Leave the field User API blank at this time

  6. Inform CHA server domain (using http)

  7. Click Save

  8. The public key will be generated. Copy this key

######## Returning to IXC ACS 4. Paste the public key in the corresponding field

  1. In the field Webhook URI, inform the provider domain followed by/api-module/acs/webhookExample:http://seuprovedor/api-module/acs/webhook6. If the SSL certificate is invalid, enable Invalid certificate

  2. Click Create API Client

  3. Copy API Client ID** generated

######## Ending at IXC Provider 9. Edit the created integration

  1. In the User API field, paste the API Client ID

  2. Save configuration

With this step completed, you can proceed to the next configurations of integration between the IXC ACS and the IXC Provider. .

To complete integration, access the content

Integração do IXC ACS com o IXC Provedor via API in Help Center.

About the public key

Unlike token, the public key does not expire quickly and is used to identify the partner system during integration. Glossary

Requisition

Invalid certificate Final considerations The API Client is the basis for any integration of the IXC ACS with external systems or the IXC Provider. By properly configuring this initial step, you guarantee automatic, safe and efficient communication between platforms, preparing the environment for the other integration settings.

Read it too ​