As APIs são um conjunto de instruções que permitem que diferentes programas se comuniquem entre si. Nesse caso, a API do IXC Provedor é baseada em formulários e seus respectivos campos no sistema. A documentação desses formulários e seus campos está disponível no seguinte link: Documentação API IXC
Nela temos as informações distribuídas da seguinte forma:
No menu localizado na lateral esquerda da tela temos os formulários agrupados por tipo seguindo o padrão do sistema IXC Provedor.
Nesses formulários é possível localizar mais informações sobre os campos utilizados nas requisições, lembrando que em caso de inserção, podem ocorrer erros, caso o campo não seja repassado de acordo.
Para ajudar no desenvolvimento, são fornecidos exemplos de como realizar os tipos de operações disponíveis na API usando diferentes linguagens de programação, como PHP, CURL, NODE, PYTHON e Postman.
A API pode ser consumida de qualquer linguagem de programação que consiga realizar uma requisição para Web e receber o retorno da mesma. O retorno normalmente será do tipo JSON de acordo com os dados solicitados.
Vale ressaltar que a API respeita a configuração de permissões do grupo de usuários vinculado ao usuário cujo Token está sendo utilizado, portanto caso o usuário não tenha permissão para acessar determinado formulário uma mensagem será retornada, como por exemplo: {"type":"error","message":"Você não tem permissão para acessar o recurso nome_formulario"}.
Caso tenha dúvidas de como alterar as permissões de um grupo de usuários, confira através da seguinte wiki: Como Alterar as Permissões em cada Grupo de Usuário
Os principais formulários estão disponíveis para listar, editar, excluir e inserir, assim como também possuímos uma lista dos recursos especiais da API localizado no menu principal da documentação.
Nessa lista você encontrará exemplos em PHP para os recursos de desbloqueio de confiança, ativação de contrato, limpar MAC, etc. Porém, caso ao consumir a API, você se depare com a mensagem {"type":"error","message":"Recurso nome_formulario não está disponível!"}, é possível entrar em contato com o setor de SUP - Suporte API - IXC Provedor através da plataforma de atendimento e solicitar a verificação da viabilidade de liberação do endpoint referente a esse determinado formulário para consumo via API.
Para consumir a API em PHP, o IXC disponibiliza um pacote de classes próprio para requisições, que pode ser encontrada na seguinte wiki Biblioteca de Classes PHP 2.0, vale a pena ressaltar que o uso dessa biblioteca não é obrigatório para o consumo da API em PHP, sendo possível desenvolver o próprio conjunto de classes para tal, entretanto, no caso da criação de um novo pacote ou alteração do pacote atual não prestamos suporte em relação ao seu consumo.