{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Esse artigo é um breve guia de como funciona a API do ","type":"text"},{"text":"SoftSwitch","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"Para o SoftSwitch é utilizado uma API Web (SOAP) a qual envia/recebe requisições HTTP expressas no formato xml.","type":"text"}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"PARA UTILIZAÇÃO DA API É NECESSÁRIO CRIAR UM USUÁRIO COM DIREITO A TODAS AS FUNCIONALIDADES QUE SERÃO REQUERIDAS DA PLATAFORMA","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Guia básico para verificação de funcionamento","type":"text"}]},{"type":"paragraph","content":[{"text":"API Web do Softswitch:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Acessar o site da de download da ","type":"text"},{"text":"SOAPUI","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.soapui.org/downloads/soapui/"}}]},{"text":" e instalar o programa (SoapUI Open Source)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Fechar a janela de Endpoint Explorer","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1847,"id":"3986d963-f008-4c6b-9b2d-4a9b3ea9d4b8","collection":"contentId-642089133","type":"file","height":1053}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CTRL + N (ou File > New SOAP Project)","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1848,"id":"7f7c0365-9a3f-481e-8a40-4f8b23babda1","collection":"contentId-642089133","type":"file","height":1051}}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Para a API Web SOAP utilizada, o padrão sempre será a utilização de endereços do tipo:","type":"text"},{"type":"hardBreak"},{"text":"http://”IP DO CLIENTE:8080/SipPulse”/”GRUPO”WS?wsdl","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Exemplo:","type":"text"},{"type":"hardBreak"},{"text":"Para listar os domínios ativos da ","type":"text"},{"text":"plataforma de demonstração","type":"text","marks":[{"type":"link","attrs":{"href":"https://demo.sippulse.com/SipPulseAdmin/"}}]},{"type":"hardBreak"},{"text":"Utilizando o endereço modelo","type":"text"},{"type":"hardBreak"},{"text":"http://","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"text":"IP_DO_CLIENTE","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"text":":8080/SipPulse/","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"text":"GRUPO","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"text":"WS?wsdl","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"As variáveis disponíveis para GRUPO são:","type":"text"},{"type":"hardBreak"},{"text":"* Subscriber","type":"text"},{"type":"hardBreak"},{"text":"* Domain","type":"text"},{"type":"hardBreak"},{"text":"* Profile","type":"text"},{"type":"hardBreak"},{"text":"* Did","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"alteramos as variáveis para utilização e temos o resultado:","type":"text"},{"type":"hardBreak"},{"text":"http://","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"text":"142.93.1.203","type":"text"},{"text":":8080/SipPulse/DomainWS?wsdl","type":"text","marks":[{"type":"link","attrs":{"href":"http://IP:8080/SipPulse/SubscriberWS?wsdl"}}]},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1846,"id":"1d479bef-d7b6-4c0b-9c53-dc8cb2a93459","collection":"contentId-642089133","type":"file","height":1051}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"obs: habilitar a opção “Create Requests:” para obter o modelo xml de cada operação do ","type":"text"},{"text":"GRUPO","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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 :","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1846,"id":"bd9cf7d2-014c-488f-b7d7-a84e09226c7b","collection":"contentId-642089133","type":"file","height":1051}}]},{"type":"paragraph"},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1850,"id":"3b0c0cc3-3d3b-4479-bc8f-0581435cc261","collection":"contentId-642089133","type":"file","height":1055}}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Modelo XML","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"Utilizando como exemplo o que está acima, o xml modelo seria:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n ?\n \n ?\n \n \n \n","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Artigos Relacionados","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"contentbylabel","parameters":{"macroParams":{"showLabels":{"value":"false"},"max":{"value":"5"},"spaces":{"value":"com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@10041"},"sort":{"value":"modified"},"showSpace":{"value":"false"},"reverse":{"value":"true"},"type":{"value":"page"},"cql":{"value":"label in ( \"api\" , \"node\" , \"soap\" , \"nodejs\" , \"soapui\" ) and type = \"page\" and space in ( \"BDC\" , \"BDCS\" )"},"labels":{"value":"api soap soapui node nodejs"}},"macroMetadata":{"macroId":{"value":"ab837401-334f-4f21-b279-8a3ef9a41316"},"schemaVersion":{"value":"4"},"title":"Content by Label"}}}},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"details","parameters":{"macroParams":{"hidden":{"value":"true"}},"macroMetadata":{"macroId":{"value":"a86138e6-bf72-4648-a103-e643de5ce56e"},"schemaVersion":{"value":"1"},"title":"Page Properties"}},"localId":"0d3d48cf-4b12-495f-8151-b7b2690cd75d"},"content":[{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[489.0]},"content":[{"type":"paragraph","content":[{"text":"Related issues","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[237.0]},"content":[{"type":"paragraph"}]}]}]}]}],"version":1}

Browser not supported