General Information on the API

API Domain

All API URLs should be accessed via the base URL[version] .

API URLs contain a version number. This will allow us to upgrade our API in the future while still continuing to support existing API clients. Replace [version] in this document with the version you are developing against. We are currently at version 1.

Authentication Method and HTTPS Protocol Support

The API uses Basic Authentication. This was chosen for the simplicity and pervasiveness that Basic provides. API requests are required to transmit over SSL (HTTPS) to ensure your credentials are safe and secure. The HTTP protocol is not supported.

If desired by the Partner, we will set up static IP restrictions to the Partner API.  This will ensure that requests may only originate from the specific set of IP addresses.

Help with Extended Request Types (PUT and DELETE)

We use the full set of request methods in our API (GET, POST, PUT, DELETE). If you find your client library does not support the extended types, you have the option of reverting to POST and adding the request parameter "_method", setting the value to the desired request method. For example:

POST "/subscribers/1234567890?_method=DELETE"

will delete the user with the phone number 1234567890.

Using POST and PUT Requests to Create and Update

The POST (for create) and PUT (for update) request methods are used in the API.  These method types require the inclusion of a request body in XML or JSON format.  Sample request bodies, usually in both XML and JSON format, are provided for each method described in this documentation.  Please not that the request body should not be URL encoded before being sent to the ProntoForms API.

UTF-8 Encoding

Every string passed to and from the Partner API should be UTF-8 encoded. To avoid any errors or errant characters, please ensure your programs and libraries support UTF-8 and be sure any Unicode strings you take as input from a user are converted before sending the data to ProntoForms.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request