XendApp - [API]

Summary

The purpose of the XendApp API is that you should be able to automate your sending of messages to the XendApp Clients.

.NET

There are many ways to utilize the API in .NET. We have created a c# assembly which you can easily reference in your project.

You can download this here.

Other languages

If you have written samples of how to use our service in other languages we would be happy to post them online - please contact us.

Our web services

Our web services for sending messages and retrieving information supports the following formats; JSON, XML, REST GET. See services below.

SendMessage

Uri template: https://xendapp.com/MessageService/SendMessage?username={userName}&password={password}

Publishes specified message to channel with POST method. Request should be in XML format.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
message - XML containing message information(string). XML fields are:
- S - Base64-encoded subject (string).
- B - Base64-encoded message (string).
- CI - channel identificator (guid).
- CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
- E - expiry date (UNIX timestamp format) (long). If set to 0, then by default equals to current date + 3 months.
- EC - flag indicating if message should be encrypted or not (bool)
Below is an example XML:

<MTS xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">
<S>TWVzc2FnZSBzdWJqZWN0</S>
TWVzc2FnZSBib2R5
<CI>1627aea5-8e0a-4371-9022-9b504344e724</CI>
<CTI>1</CTI>
<E>922337203</E>
<EC>true</EC>
</MTS>

Returns created message identificator (guid) in XML format.

SendMessageJson

Uri template: https://xendapp.com/MessageService/SendMessageJson?username={userName}&password={password}

Publishes specified message to channel with POST method. Request should be in JSON format.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
message - JSON containing message information (string). JSON fields are:
- S - Base64-encoded subject (string).
- B - Base64-encoded message (string).
- CI - channel identificator (guid).
- CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
- E - expiry date (UNIX timestamp format) (long). If it set to 0, then by default equals to current date + 3 months.
- EC - flag indicating if message should be encrypted or not (bool)
Below is an example JSON string:

{
"S":"TWVzc2FnZSBzdWJqZWN0",
"B":"TWVzc2FnZSBib2R5",
"CI":"1627aea5-8e0a-4371-9022-9b504344e724",
"CTI":2147483647,
"E":9223372036854775807,
"EC":true
}

Returns created message identificator (guid) in JSON format.

SendPlainTextMessage

Uri template: https://xendapp.com/MessageService/SendPlainTextMessage?username={userName}&password={password}

Publishes specified message to channel with POST method. Request should be in XML format.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
message - XML containing message information (string). XML fields are:
- S - plain text subject (string).
- B - plain text message (string).
- CI - channel identificator (guid).
- CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
- E - expiry date (UNIX timestamp format) (long). If it set to 0, then by default equals to current date + 3 months.
- EC - flag indicating if message is encrypted or not (bool)
Below is an example XML:

<MTS xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">
<S>Message subject</S>
Message body
<CI>1627aea5-8e0a-4371-9022-9b504344e724</CI>
<CTI>1</CTI>
<E>922337203</E>
<EC>true</EC>
</MTS>

Returns created message identificator (guid) in XML format.

SendPlainTextMessageJson

Uri template: https://xendapp.com/MessageService/SendPlainTextMessageJson?username={userName}&password={password}

Publishes specified message to channel with POST method. Request should be in JSON format.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
message - JSON containing message information (string). JSON fields are:
- S - plain text subject (string).
- B - plain text message (string).
- CI - channel identificator (guid).
- CTI - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
- E - expiry date (UNIX timestamp format) (long). If it set to 0, then by default equals to current date + 3 months.
- EC - flag indicating if message is encrypted or not (bool)
Below is an example JSON:

{
"S":"Message subject",
"B":"Message body",
"CI":"1627aea5-8e0a-4371-9022-9b504344e724",
"CTI":2147483647,
"E":9223372036854775807,
"EC":true
}

Returns created message identificator (guid) in JSON format.

Uri template: https://xendapp.com/MessageService/SendMessageWithGet?username={userName}&password={password}&subject={subject}&contentTypeId={contentTypeId}&body={body}&expire={expire}&channelId={channelId}&encrypted={encrypted}

Publishes specified message to channel with GET method.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
subject - Base64-encoded subject (string).
body - Base64-encoded message (string).
channelId - channel identificator (guid).
contentTypeId - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
expire - expiry date (UNIX timestamp format) (long). If it set to 0, then default equals to current date + 3 months.
encrypted - flag indicating if message should be encrypted or not (bool)

Returns created message identificator (guid) in XML format.

SendPlainTextMessageWithGet

Uri template: https://xendapp.com/MessageService/SendPlainTextMessageWithGet?username={userName}&password={password}&subject={subject}&contentTypeId={contentTypeId}&body={body}&expire={expire}&channelId={channelId}&encrypted={encrypted}

Publishes specified message to channel with GET method.

Parameters:

username - sender's username. (string)
password - sender's password. (string)
subject - plain text subject (string).
body - plain text message (string).
channelId - channel identificator (guid).
contentTypeId - content type (can be 1 or 2) (int). 1 - PlainText, 2 - HTML.
expire - expiry date (UNIX timestamp format) (long). If it set to 0, then default equals to current date + 3 months.
encrypted - flag indicating if message is encrypted or not (bool)

Returns created message identificator (guid) in XML format.

GetUserChannels

Uri template: https://xendapp.com/ChannelService/GetUserChannels?username={userName}&password={password}

Gets user's subscriptions grouped by provider.

Parameters:

username - user's username. (string)
password - user's password. (string)

Returns list of channels grouped by provider in XML format. XML fields are:

UCS - array of user channels (PHS[]) (wrapper for response).
PHS - array of provider headers (PH[]).
PH - data contract, which contains short information about provider (class).
PH.I - provider identificator (guid).
PH.N - provider name (string).
CHS - array of channel headers (CH[]).
CH - data contract, which contains short information about channel (class).
CH.I - channel identificator (guid).
CH.N - channel name (string).

Below is an example response XML:

<UCS xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">
<PHS>
<PH>
<CHS>
<CH>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</CH>
<CH>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</CH>
</CHS>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</PH>
<PH>
<CHS>
<CH>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</CH>
<CH>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</CH>
</CHS>
1627aea5-8e0a-4371-9022-9b504344e724
<N>String content</N>
</PH>
</PHS>
</UCS>

GetUserChannelsJson

Uri template: https://xendapp.com/ChannelService/GetUserChannelsJson?username={userName}&password={password}

Gets user's subscriptions grouped by provider.

Parameters:

username - user's username. (string)
password - user's password. (string)

Returns list of channels grouped by provider in JSON format. JSON fields are:

UCS - array of user channels (PHS[]) (wrapper for response).
PHS - array of provider headers (PH[]).
PH - data contract, which contains short information about provider (class).
PH.I - provider identificator (guid).
PH.N - provider name (string).
CHS - array of channel headers (CH[]).
CH - data contract, which contains short information about channel (class).
CH.I - channel identificator (guid).
CH.N - channel name (string).

Below is an example response JSON:

{
"PHS":[{
"CHS":[{
"I":"1627aea5-8e0a-4371-9022-9b504344e724",
"N":"String content"
}],
"I":"1627aea5-8e0a-4371-9022-9b504344e724",
"N":"String content"
}]
}

GetUserProvidersWithChannels

Uri template: https://xendapp.com/ProviderService/GetUserProvidersWithChannels?username={userName}&password={password}

Gets user's channels grouped by provider.

Parameters:

username - user's username. (string)
password - user's password. (string)

Returns array of providers (P[]). XML fields for each provider are:

I - provider identificator (guid).
N - provider name (string).
D - provider description (string).
IP - flag indicating if provider is public (bool).
LG - logo (byte[]). In this method this field is null.
CR - creation date (UNIX timestamp format) (long).
CS - array of channels (C[]).

XML fields for each channel in CS array are:

I - channel identificator (guid).
N - channel name (string).
D - channel description (string).
IP - flag indicating if channel is public (bool).
PI - provider identificator (guid).
PW - password as guid (guid).
CPW - cropped password (first 8 characters of PW) (string).

Below is an example response XML:

<ArrayOfP xmlns="http://schemas.datacontract.org/2004/07/Xend.Business.CompositeTypes">

<CR>9223372036854775807</CR>
<CS>
<C>
<CPW>String content</CPW>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<N>String content</N>
<PI>1627aea5-8e0a-4371-9022-9b504344e724</PI>
<PW>1627aea5-8e0a-4371-9022-9b504344e724</PW>
</C>
<C>
<CPW>String content</CPW>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<N>String content</N>
<PI>1627aea5-8e0a-4371-9022-9b504344e724</PI>
<PW>1627aea5-8e0a-4371-9022-9b504344e724</PW>
</C>
</CS>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<LG xsi:nil="true"/>
<N>String content</N>


<CR>9223372036854775807</CR>
<CS>
<C>
<CPW>String content</CPW>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<N>String content</N>
<PI>1627aea5-8e0a-4371-9022-9b504344e724</PI>
<PW>1627aea5-8e0a-4371-9022-9b504344e724</PW>
</C>
<C>
<CPW>String content</CPW>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<N>String content</N>
<PI>1627aea5-8e0a-4371-9022-9b504344e724</PI>
<PW>1627aea5-8e0a-4371-9022-9b504344e724</PW>
</C>
</CS>
<D>String content</D>
1627aea5-8e0a-4371-9022-9b504344e724
<IP>true</IP>
<LG xsi:nil="true"/>
<N>String content</N>

</ArrayOfP>

GetUserProvidersWithChannelsJson

Uri template: https://xendapp.com/ProviderService/GetUserProvidersWithChannelsJson?username={userName}&password={password}

Gets user's channels grouped by provider.

Parameters:

username - user's username. (string)
password - user's password. (string)

Returns array of providers (P[]). JSON fields for each provider are:

I - provider identificator (guid).
N - provider name (string).
D - provider description (string).
IP - flag indicating if provider is public (bool).
LG - logo (byte[]). In this method this field is null.
CR - creation date (UNIX timestamp format) (long).
CS - array of channels (C[]).

JSON fields for each channel in CS array are:

I - channel identificator (guid).
N - channel name (string).
D - channel description (string).
IP - flag indicating if channel is public (bool).
PI - provider identificator (guid).
PW - password as guid (guid).
CPW - cropped password (first 8 characters of PW) (string).

Below is an example JSON string:

[{
"CR":9223372036854775807,
"CS":[{
"CPW":"String content",
"D":"String content",
"I":"1627aea5-8e0a-4371-9022-9b504344e724",
"IP":true,
"N":"String content",
"PI":"1627aea5-8e0a-4371-9022-9b504344e724",
"PW":"1627aea5-8e0a-4371-9022-9b504344e724"
}],
"D":"String content",
"I":"1627aea5-8e0a-4371-9022-9b504344e724",
"IP":true,
"LG": null,
"N":"String content"
}]