Link Engage Rest API version 2

Modified on Tue, 24 Sep 2024 16:13 by FM — Categorized as: Intouch, Intouch REST API

Preface
This page documents version 2 of the Link Engage REST API, which can be used to access much of the functionality found in Link Engage, such as (but not limited to) creating groups and contacts, sending messages, configuring automatic services etc.
The documentation assumes basic knowledge about implementing restfull API's.

Table of Contents [Hide/Show]

   Resources
   URL
   Parameters in HTTP Request Headers
      Authorization
      Content-Type
   HTTP Response codes from the API
   Sample HTTP Requests
   .Net Client library

Resources¶

Several resources are available for accessing the functionality of the Link Engage application:
To minimize the risk of the API documentation coming out of sync with the API, the bulk of the API documentation is based around autogenerated content hosted at the API itself.
URL: https://intouchapi.pswin.com/2/help

Contacts - Used for editing contacts in the Link Engage Address Book
Groups - Used for editing groups in the Link Engage Address Book, and also for adding and removing contacts from groups.
Messages - Used for sending messages to contacts and/or groups, and for accessing messages in the Link Engage Messages Folders.
Services - Used for editing Link Engage services, such as SMS autoreplies, SMS forwarding and so on.
Servicepoints - Used for seeing all service keywords registered for an Link Engage account.
Users - Used for editing users that can login to a Link Engage Account.
Senders - Used for editing the Sender strings that can be used on messages sent from Link Engage.

URL¶

The base url of the Link Engage rest API is: https://intouchapi.pswin.com/2

Parameters in HTTP Request Headers¶

Authorization¶

All requests to the Link Engage REST API must be authenticated with a HTTP Basic Authentication header.
The authentication content must be a Base64-encoded string consisting of your user name, your organization's domain and your API password in this format:

username@domain:password

The full authentication header would look like this:

Authorization: Basic dXNlcm5hbWVAZG9tYWluOnBhc3N3b3Jk

For information about Base64 encoding, see: Base64 Encoding examples

Content-Type¶

Either application/json or application/xml is accepted, based on your preferred way of supplying data.

HTTP Response codes from the API¶

200 OK - Upon successfull GET request
201 Created - Upon successfull POST request. Also uri to newly created entity will be supplied in Response Location header.
204 NoContent - Upon successfull PUT and DELETE request, indicates that the LINK Engage database was actually updated.

Sample HTTP Requests¶

Some sample HTTP requests have been documented: Sample HTTP requests for Intouch REST API v2