Esse artigo é um breve guia de como funciona a API do SoftSwitch
API vem do inglês Application Programming Interface (Interface de programação de aplicação), sua finalidade é permitir o desenvolvimento de programas e/ou aplicações sem a compreensão de todas as partes do sistema.

Para o SoftSwitch é utilizado uma API Web (SOAP) a qual envia/recebe requisições HTTP expressas no formato xml.

PARA UTILIZAÇÃO DA API É NECESSÁRIO CRIAR UM USUÁRIO COM DIREITO A TODAS AS FUNCIONALIDADES QUE SERÃO REQUERIDAS DA PLATAFORMA

Guia básico para verificação de funcionamento

API Web do Softswitch:

Acessar o site da de download da SOAPUI e instalar o programa (SoapUI Open Source)
Fechar a janela de Endpoint Explorer
CTRL + N (ou File > New SOAP Project)
Para a API Web SOAP utilizada, o padrão sempre será a utilização de endereços do tipo:
http://”IP DO CLIENTE:8080/SipPulse”/”GRUPO”WS?wsdl
Exemplo:
Para listar os domínios ativos da plataforma de demonstração
Utilizando o endereço modelo
http://IP_DO_CLIENTE:8080/SipPulse/GRUPOWS?wsdl

As variáveis disponíveis para GRUPO são:
* Subscriber
* Domain
* Profile
* Did

alteramos as variáveis para utilização e temos o resultado:
http://142.93.1.203:8080/SipPulse/DomainWS?wsdl

obs: habilitar a opção “Create Requests:” para obter o modelo xml de cada operação do GRUPO
Ao dar OK a operação será realizada e os requests modelos serão criados na árvore a esquerda permitindo a verificação das informações que a plataforma exige (para abrir o Request é só dar 2 cliques :
Para obter a resposta para a request só é necessário preencher o campos com “?” que serão utilizados para obtenção da resposta da plataforma, incluindo o usuário criado para a utilização da API
O painel a direta apresenta as informações obtidas da requisição enviada, aí depende apenas do desenvolvedor filtrar e utilizar a informação como desejar

Modelo XML

O xml a ser utilizado na api é o conteúdo do painel a esquerda, pode ser copiado e salvo em um arquivo de texto com a extensão .xml.

Utilizando como exemplo o que está acima, o xml modelo seria:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.sippulse.voffice.com.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:listDomains>
         <!--Optional:-->
         <principal>
            <!--Optional:-->
            <login>?</login>
            <!--Optional:-->
            <password>?</password>
         </principal>
      </ser:listDomains>
   </soapenv:Body>
</soapenv:Envelope>

Base de conhecimento SIPPulse

API

Guia básico para verificação de funcionamento

Modelo XML

Artigos Relacionados