Objective: Review how to use access the Bulkvs.com Origination and 911 SOAP API using SOAP UI

Transcription

1 Objective: Review how to use access the Bulkvs.com Origination and 911 SOAP API using SOAP UI Perquisites: 1. Have access to your bulkvs.com API ID 2. Have an MD5 equivalent of your bllkvs.com password 3. Download and install soapui Step 1: Log in and retrieve your API Key 1.Go to bulkcnam.com and sign up for a free account (if you do not have one already) 2.Once logged in click on Origination Portal 3.Your API Key is listed under My Account: (For example: API Key: ad4cdd89b7a7b7c73935f81746apd93) Step 2: Getting your MD5 equivalent password 1. There are several ways to get your MD5 equivalent. The easiest is to go to a website that generates MD5 strings. One such site is 2. open a web browser and go to 3. Enter your bulkvs.com password in the text box 4. press MD5. 5. In the below example my password is password123 and the MD5 equivalent is 482c811da5d5b4bc6d497ffa98491e38

2 Step3: Download SoapUI 1.Go to soapui.com to download a free copy of soapui.com 2.Once you are at the site click on the downloads -> download soapui 3.Then click on soapui 4.Click on the version you would like to download. As of this writing 4.5 is out 5. Click on the soapui-x32-4_5_0.exe (or sopaui-x65-4_5_0.exe if you have a 64 bit system) 6.Once downloaded install the application

3 Step4: Starting soapui and testing bulkvs.com s API 1.Start soapui on your pc 2.Once SoapUI starts click on file -> new soap Project 3. Enter the WSDL bulkvs.com link in the Initial WSDL/WADL section and click ok 4. At this point you will see all of the API options bulkvs.com offers (ex: queryaccount, DnOrder, e911provisionaddress etc )

4 Step5: Running a query using your account information. (query account status) 1.At this point you should have already started SoapUI and have entered the Bulkvs.com WSDL link for the project (Step4 above). You should have also retrieved your API Key(Step1 above) and have the MD5 equivalent of your bulkvs.com password (step 2 above) 2.Click on queryaccount to expand the drop down then double click on Request 1. On the right had side you should now have an XML output requesting your apikey and apisecret 3.If you have been following from step1 my apikey is ad4cdd89b7a7b7c73935f81746apd93 which I retrieved from logging in to bulkcnam.com and click on origination. My apisecret is my MD5 equivalent of my password when I log in to bulkcnam.com. In this case it is: 482c811da5d5b4bc6d497ffa98491e38 apikey: ad4cdd89b7a7b7c73935f81746apd93 apisecret: 482c811da5d5b4bc6d497ffa98491e38 4.Now that I have all the necessary information we could query my account info and click on the Green Run button on the top left

5 5.After I click on the run button the bulkvs.com API will respond back with an XML output. In this case you could see the username, balance, credit, lowbalancenotification etc Here are the steps to provision a number: 1) First run "e911validateaddress" to validate a US or Canadian address <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" <soapenv:header/> <soapenv:body> <soapenv:e911validateaddress soapenv:encodingstyle=" <apikey xsi:type="xsd:string">your_apikey</apikey> <apisecret xsi:type="xsd:string">your_apisecret</apisecret> <address1 xsi:type="xsd:string">704 N. King St.</address1> <address2 xsi:type="xsd:string"></address2> <city xsi:type="xsd:string">wilmington</city> <state xsi:type="xsd:string">de</state> <zip xsi:type="xsd:string">19801</zip> </soapenv:e911validateaddress> </soapenv:body> </soapenv:envelope> Response will be an Address ID: "<addressid xsi:type="xsd:string"> </addressid>"

6 <SOAP-ENV:Envelope SOAP-ENV:encodingStyle=" xmlns:soap-env=" xmlns:xsd=" xmlns:xsi=" xmlns:soap-enc=" <SOAP-ENV:Body> <SOAP-ENV:e911validateAddressResponse> <result> <description xsi:type="xsd:string">ok</description> <entry0> <addressid xsi:type="xsd:string"> </addressid> <address1 xsi:type="xsd:string">704 N KING ST</address1> <address2 xsi:type="xsd:string"/> <city xsi:type="xsd:string">wilmington</city> <state xsi:type="xsd:string">de</state> <zip xsi:type="xsd:string">19801</zip> <time xsi:type="xsd:int"> </time> </entry0> </result> </SOAP-ENV:e911validateAddressResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> 2) You would use the Address ID retrieved through Step 1, and call "e911provisionaddress" with the phone number (dn), Name (callername) and Address ID (addressid). <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" <soapenv:header/> <soapenv:body> <soapenv:e911provisionaddress soapenv:encodingstyle=" <apikey xsi:type="xsd:string">your_apikey</apikey> <apisecret xsi:type="xsd:string">your_apisecret</apisecret> <dn xsi:type="xsd:string"> </dn> <callername xsi:type="xsd:string">bulk Solutions LLC</callername> <addressid xsi:type="xsd:string"> </addressid> </soapenv:e911provisionaddress> </soapenv:body> </soapenv:envelope> 3) Upon success you will receive an XML with description set to "OK" and the name and address provisioned. Upon failure, a failure result will be returned. <SOAP-ENV:Envelope SOAP-ENV:encodingStyle=" xmlns:soap-env=" xmlns:xsd=" xmlns:xsi="

7 xmlns:soap-enc=" <SOAP-ENV:Body> <SOAP-ENV:e911provisionAddressResponse> <result> <description xsi:type="xsd:string">ok</description> <entry> <dn xsi:type="xsd:string"> </dn> <callername xsi:type="xsd:string">bulk Solutions LLC</callername> <address1 xsi:type="xsd:string">704 N KING ST</address1> <address2 xsi:type="xsd:string"/> <city xsi:type="xsd:string">wilmington</city> <state xsi:type="xsd:string">de</state> <zip xsi:type="xsd:string">19801</zip> </entry> </result> </SOAP-ENV:e911provisionAddressResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> To update an address for a number already on record with us, just repeat steps 1-3, and account will not get charged. Deletions occur through the API call "e911removerecord" and provide the phone number as "dn". Errors you will get back from us will indicate Failure and reason under "Description". Basically, unless you get an OK from us in "Description", then that means there's been a problem and API call should be corrected and reissued. ======================= PHP Example: <? function bulkvs_queryaccount($apikey, $apisecret){ require_once 'SOAP/Client.php'; $wsdl_url = " $WSDL = new SOAP_WSDL($wsdl_url); $client = $WSDL->getProxy(); $apisecrethashed = md5($apisecret); $result = $client->queryaccount($apikey, $apisecrethashed); print_r($result); return; } function bulkvs_query911record($apikey, $apisecret, $dn){ require_once 'SOAP/Client.php'; $wsdl_url = " $WSDL = new SOAP_WSDL($wsdl_url); $client = $WSDL->getProxy(); $apisecrethashed = md5($apisecret); $result = $client->e911queryrecord($apikey, $apisecrethashed, $dn); print_r($result); return; } $id = "<yourid>"; $secret = "<password>"; $dn = " "; $result1 = bulkvs_queryaccount($id, $secret);

8 $result2 = bulkvs_query911record($id, $secret, $dn);?> Should provide: stdclass Object ( [description] => OK [entry] => stdclass Object ( [username] => genusys [balance] => 9.55 [credit] => 0 [lowbalancenotification] => 5 [CNAMfee] => [TNfee] => 0.35 [TNsetupfee] => 0.64 [LIDBupdatefee] => 0.2 [e911enabled] => yes [e911fee] => 0.72 ) ) stdclass Object ( [description] => OK [entry] => stdclass Object ( [dn] => [callername] => John Smith [address1] => 777 Test Road [address2] => [city] => COPPELL [state] => TX [zip] => ) )