DEVELOPER GUIDEv1

Getting Started

  1. Login to your account, or sign up if you still don’t have a ProTexting account.

  2. Go to our marketplace, and activate the API Apps that you need. No need to activate all API apps if you don’t need them all.

  3. Get your oAuth API access token by going to “Settings” » “Developers API Keys”.

  4. You are ready to start integrating! If you need help, contact us and we’ll be glad to answer all of your questions.

ProTexting API

2. Results per page and Pagination:

Every page contains 100 results. Use page as a get parameter to access the other pages.

example:

Example
# Get the second page of results for the Inbox index action.
/inbox/index?page=2

Use HTTP Response Headers for pagination:

HeaderDescription
X-Pagination-Current-PageThe current page. Defaults to 1.
X-Pagination-Page-CountThe total number of pages in the result set. Use this along with X-Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.
X-Pagination-Total-CountThe total number of records.
X-Pagination-Per-PageThe count records of page

Other valid solution is using the Link header introduced by RFC 5988.

Example
Link: <inbox/index?access_token=xxx&page=1&per-page=100>; rel=self, <....> ; rel=first, .......

3. Supported request header formats:

Content-TypeAccept
JSONapplication/jsonapplication/json
XMLapplication/xmlapplication/xml

4. Supported response formats:

XML & JSON. The used format depends on the passed header in the request.

5. Error Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

6. Date and Time Format:

All dates and times are in (GMT -5:00) Eastern Standard Time (EST) and the following format: YYYY-MM-DD HH:MM:SS

7. Getting started

More information on how to obtain your access token is available here: API Getting Started »

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.