The Basics

Refer to our Getting Started article for information about authentication, sandboxing, and Console access.


You will need the following to get started:

  • SOAP credentials

  • sourceID (unique to account)


Use the endpoint for Contact API and Wifi Interaction API provided in our SOAP API documentation.

Below is a summary of the API methods to use when writing contact and Wifi data to Airship.

  • createContact  

  • contactValidation  

  • unitList 

  • groupList  

  • getConsentTypes 

  • createWifiInteraction 

  • assignWifiInteractionUnit 

Writing a contact record

  • Creating a record in Airship requires a mandatory consent array, and a mandatory groups array. The IDs required by these arrays can be obtained by using our API.

  • Use API method unitList  to retrieve the unitIDs. Use the returned unitIDs when you make requests to groupList to retrieve the groupIDs.

  • Use API method getConsentTypes  to retrieve the consent IDs, which you will use when creating your consents array when making a createContact request.

  • Refer to the .NET and PHP examples in our SOAP API documentation in the footer of our website for more information.

  • To begin, make a SOAP request to API method createContact , with an array of contact data, using the groupIDs and consentIDs you retrieved earlier.

Writing a Wifi transactional record

The createWifiInteraction API method expects these parameters:

Hotspot_name - The name of the access point, such as “Upstairs Lounge”.

Mac_address - Either the MAC address of the access point or the device connecting to Wifi.

Device_mime_type - A unique identifier of the splash page or device, such as “Wifi splash page”.


The Interaction type is one of the following:

  • detected - this interaction type should be used when a user's device passively connects to the WiFi hotspot.

  • connected - this interaction type should be used once a user pro actively views your captive portal.

  • authenticated - this interaction type should be used once a user has provided the information required by the captive portal to connect to the Internet via your WiFi service.

  • disconnected - this interaction type should be used when a device which was connected to your WiFi service disconnects, for example where a used logs out on the captive portal or a timed connection expires.

contactID - The unique ID of the contact that is returned when using the createContact API method.

Attach the Wifi transaction to a Unit

In Airship, Units are the individual physical locations of a business. For example, if an account has a location in Sheffield, they will have a Sheffield unit.

Use the UnitList API method to list the units for the account, and to retrieve the unique unitID identifiers for each Unit.

You can then use assignWifiInteractionUnit to attach the Wifi transaction to the Unit, passing the unique ID for the Wifi transaction with the ID for the Unit.


To validate data before passing to Airship, use the contactValidation  API method. This allows you to use Airship’s validation rules instead of writing your own to replicate Airship’s Console.

For more information on how to write data to the Console, click here.

Did this answer your question?