API Overview
We have developed a robust set of features exposed as an API. Once setup with a developers account, you can use our API to develop pURL enabled applications.
For a reference on all API services please see our API Documentation
Getting Started
Step 1
Obtain an API key from Boingnet. This key will be used for each web service call to authenticate your application
Step 2
Review the 2 API WSDLs located at http://www.boingnet.com/bnapi.asmx?WSDL and http://www.boingnet.com/bnapireport.asmx?WSDL The Boingnet API is an XML SOAP based service.
Step 3
Using your main Boingnet account, login and create a small sample campaign of 5 records. This campaign will be used for testing the development API calls
Step 4
Once you have a campaign created, you must find the campaign id. You can do this by hovering over the ‘Edit’ link on the campaign listing. A URL will look something like http://www.boingnet.com/CampaignDetails.aspx?campainId=####. You will need this id for the development API calls
Step 5
Using the application key from step 1 and the campaign id from step 4, you can make the first call to the getPurlsFromCampaign function.
getPurlsFromCampaign(string Key, int CampaignId)
| Parameters | |
| Key | A valid API Key for your Boingnet account. |
| CampaignId | The Boingnet campaign id to get pURLs for |
| Error Codes | |||||||||
| int |
|
||||||||
| Returns | |
| complex | DataId Unique id for pURL record
DataGUID GUID id for pURL record CampaignId Campaign Id FirstName LastName City State Zip Address Address2 EmailId Company Occupation VarField1 VarField2 VarField3 VarField4 pURL Personal URL VarField5 VarField6 VarField7 VarField8 VarField9 VarField10 VarField11 VarField12 VarField13 VarField14 VarField15 VarField16 VarField17 VarField18 VarField19 VarField20 VarField21 VarField22 VarField23 VarField24 VarField25 VarField26 VarField27 VarField28 VarField29 VarField30 VarField31 VarField32 VarField33 VarField34 VarField35 LastVisited Timestamp of last time pURL was openened |
Step 6
Using the application key from step 1 and additional parameters, make calls to updatePurlToCampaign, addPurlToCampaign and deletePurlFromCampaign. Login to your Boingnet account, click ‘Edit’ on the sample campaign and then click the ‘pURL Records’ tab. From here, check that your records have been added, updated and deleted properly