Implementing an Application Integration Server - Revision history

Ltalaschus: /* Python */

2017-04-20T13:40:04Z

Python

Ltalaschus: /* Python */

2017-04-20T07:58:48Z

Python

Ltalaschus: /* Python */

2016-12-12T09:26:41Z

Python

Dweuthen at 15:27, 15 September 2015

2015-09-15T15:27:44Z

Dweuthen at 15:48, 23 March 2015

2015-03-23T15:48:08Z

Dweuthen: Created page with "The following describes how to implement your own Application Integration server to synchronize users from sources that are not natively supported by MailStore. This can be vi..."

2015-03-23T15:28:33Z

Created page with "The following describes how to implement your own Application Integration server to synchronize users from sources that are not natively supported by MailStore. This can be vi..."

New page

The following describes how to implement your own Application Integration server to synchronize users from sources that are not natively supported by MailStore. This can be virtually any user database that can be accessed via programming or scripting languages, for instance SQL server databases or plain text files. Using an Application Integration server as a directory service for synchronization and authorization is described in [[Application Integration]].

Application Integration servers can be written in any programming or scripting language. They must either provide their own HTTP server interface or be accessible through an existing HTTP server.

=== Synchronizing Users ===
The Application Integration server must accept the following parameter via HTTP POST request to initialize the synchronization.

{| class="wikitable"
! width=80px | Name
! Description
|-
| <tt>cmd</tt>
| For synchronizing users the ''cmd'' parameter must be set to ''list''.
|}

The returned HTTP response must contain valid JSON formatted data. When synchronizing users, the following data structure is expected for each user object. Multiple users must be returned as an array of JSON objects.

{| class="wikitable"
! width=150px | Name
! width=120px | Type
|-
| <tt>userName</tt>
| string
|-
| <tt>distinguishedName</tt>
| string ''(optional)''
|-
| <tt>fullName</tt>
| string ''(optional)''
|-
| <tt>emailAddresses</tt>
| array ''(optional)''
|}

=== Example ===

==== HTTP Request ====
<source lang="xml" toolbar="false" gutter="false">
POST /mailstore-integration/index.php HTTP/1.1
Authorization: Basic bWFpbHN0b3JlQGV4YW1wbGUudGVzdDpQYXNzdzByZA==
User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
Host: mail.example.test
Accept: */*
Content-Length: 8
Content-Type: application/x-www-form-urlencoded

cmd=list
</source>

==== HTTP Response ====
<source lang="xml" toolbar="false" gutter="false">
HTTP/1.1 200 OK
X-Powered-By: PHP/5.4.4-14+deb7u5
Content-Type: text/json; charset=utf8
Date: Fri, 13 Dec 2013 14:20:27 GMT
Server: lighttpd/1.4.31
Content-Length: 23812
Accept-Ranges: none
Connection: Keep-Alive

[
{
"userName": "john.doe",
"distinguishedName": "UID=john.doe,DC=example,DC=com",
"fullName": "john.doe",
"emailAddresses": [
"john.doe@example.com",
"john@example.com"
]
},
{
"userName": "jane.doe",
"distinguishedName": "UID=jane.doe,DC=example,DC=com",
"fullName": "jane.doe",
"emailAddresses": [
"jane.doe@example.com",
"jane@example.com"
]
}
]
</source>

=== Authenticating Users ===
The Application Integration server must accept the following parameters via HTTP POST request to authenticate users.

{| class="wikitable"
! width=80px | Name
! Description
|-
| <tt>cmd</tt>
| For authenticating users the ''cmd'' parameter must be set to ''auth''.
|-
| <tt>user</tt>
| The ''user'' parameter contains the user name to be authenticated.
|-
| <tt>pass</tt>
| The ''pass'' parameter contains the password to be verified.
|}

The returned HTTP response must contain valid JSON formatted data. When authenticating users, the following data structure is expected.

{| class="wikitable"
! width=150px | Name
! width=120px | Type
|-
| <tt>succeeded</tt>
| boolean
|}

=== Examples ===

==== HTTP Request ====
<source lang="xml" toolbar="false" gutter="false">
POST /mailstore-integration/index.php HTTP/1.1
Authorization: Basic bWFpbHN0b3JlQGV4YW1wbGUudGVzdDpQYXNzdzByZA==
User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
Host: mail.example.test
Accept: */*
Content-Length: 8
Content-Type: application/x-www-form-urlencoded

cmd=auth&user=john.doe&pass=Passw0rd
</source>

==== HTTP Response - Authentication Successful ====
<source lang="xml" toolbar="false" gutter="false">
HTTP/1.1 200 OK
X-Powered-By: PHP/5.4.4-14+deb7u5
Content-Type: text/json; charset=utf8
Date: Fri, 13 Dec 2013 14:20:27 GMT
Server: lighttpd/1.4.31
Content-Length: 21
Accept-Ranges: none
Connection: Keep-Alive

{
succeeded: true
}
</source>

==== HTTP Response - Authentication Failed ====
<source lang="xml" toolbar="false" gutter="false">
HTTP/1.1 200 OK
X-Powered-By: PHP/5.4.4-14+deb7u5
Content-Type: text/json; charset=utf8
Date: Fri, 13 Dec 2013 14:20:27 GMT
Server: lighttpd/1.4.31
Content-Length: 22
Accept-Ranges: none
Connection: Keep-Alive

{
succeeded: false
}
</source>

@@ Line 160: / Line 160: @@
 === Python ===
-An implementation of a modular Application Integration Server written in Python can be found in the [[Media:Application-integration-server.zip|application-integration-server.zip]] file.
+An implementation of a modular Application Integration Server written in Python can be found [[Media:Application-integration-server.zip|here]].
 [[de:Implementieren eines Application Integration Servers]]
 [[en:Implementing_an_Application_Integration_Server]]

@@ Line 160: / Line 160: @@
 === Python ===
-An implementation of a modular Application Integration Server written in Python can be found in the [http://ftp.mailstore.com/pub/Scripts/Python/application-integration-server.zip application-integration-server.zip] file.
+An implementation of a modular Application Integration Server written in Python can be found in the [[Media:Application-integration-server.zip|application-integration-server.zip]] file.
 [[de:Implementieren eines Application Integration Servers]]
 [[en:Implementing_an_Application_Integration_Server]]

@@ Line 160: / Line 160: @@
 === Python ===
-An implementation of a modular Application Integration Server written in Python can be found in the [ftp://ftp.mailstore.com/pub/Scripts/Python/application-integration-server.zip application-integration-server.zip] file.
+An implementation of a modular Application Integration Server written in Python can be found in the [http://ftp.mailstore.com/pub/Scripts/Python/application-integration-server.zip application-integration-server.zip] file.
 [[de:Implementieren eines Application Integration Servers]]
 [[en:Implementing_an_Application_Integration_Server]]

← Older revision		Revision as of 15:48, 23 March 2015
Line 154:		Line 154:
	}		}
	</source>		</source>
		+
		+	[[de:Implementieren eines Application Integration Servers]]
		+	[[en:Implementing_an_Application_Integration_Server]]

@@ Line 3: / Line 3: @@
 Application Integration servers can be written in any programming or scripting language. They must either provide their own HTTP server interface or be accessible through an existing HTTP server.
-=== Synchronizing Users ===
+== Synchronizing Users ==
 The Application Integration server must accept the following parameter via HTTP POST request to initialize the synchronization.
@@ Line 81: / Line 81: @@
 </source>
-=== Authenticating Users ===
+== Authenticating Users ==
 The Application Integration server must accept the following parameters via HTTP POST request to authenticate users.
@@ Line 154: / Line 154: @@
+}
 </source>
 [[de:Implementieren eines Application Integration Servers]]
 [[en:Implementing_an_Application_Integration_Server]]