Integration and interfaces
ESME can play a part in the IT of your organization, especially to connect processes with the people executing them. Most of the scenarios are based on available APIs in the ESME software.
Name of the API | Status | Comments | more details at... | |
---|---|---|---|---|
ESME REST-like API | Out-of-the-box available | The current API does not completely fulfill the requirements of RESTful APIs. Compliance with the REST standard is however on the tasklist of the team. | [Link to description](restapi.html) | |
Twitter-like API | Out-of-the-box available | Compliance with the Twitter-API serves to enable usage of Twitter clients with an ESME instance. {footnote} Current positioning is that ESME will have in future both a twitter-like and an own API.{footnote} | [Link to documentation](twitter-api.html) , [Link to SVN | http://svn.apache.org/viewvc/incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala?view=log] |
Based on the APIs mentioned above, the following clients/programming libraries are available:{footnote}All entries are based on the REST-like API, if not stated otherwise.{footnote}
Programming language or environment | Status | More details at... | ||
---|---|---|---|---|
ABAP Client | Working source code available | [Generic Web-Dynpro ABAP Client source code](http://code.google.com/p/esmeproject/source/browse/trunk/esme-abap/ESME+ABAP+Client/) , [ABAP Send message source code | http://code.google.com/p/esmeproject/source/browse/trunk/esme-abap/#esme-abap/ABAP%20Send%20Message%20REST%20API%20and%20Function%20module] , [ABAP Object Watch | http://code.google.com/p/esmeproject/source/browse/trunk/esme-abap/#esme-abap/ABAP%20Object%20Watch] |
Adobe AIR client | Out-of-the-box available | [Installation guide](esme-desktop-air-client.html) | ||
Apache ANT action | JAR file available | [Link to blog entry]('http://blog.esme.us/esme-client-for-ant/.html) | ||
Java Library | JAR file available | [Link to blog entry](http://blog.esme.us/improved-java-api-moved-to-apache/) | ||
JavaScript Client | Example script available | [Link to code.google.com](http://code.google.com/p/esmeproject/wiki/PureJavascript_messaging_client) [Link to blog entry | http://blog.esme.us/pure-javascript-messaging-client/] | |
PLSQL Client | Example script available | [Link to code.google.com](http://code.google.com/p/esmeproject/wiki/PL_SQL_Client_for_ESME) | ||
SAP NetWeaver Logger Client | Example script available | [Link to blog entry](http://blog.esme.us/the-netweaver-logger/) | ||
VBA Client | Example script available | [Link to blog entry](http://blog.esme.us/esme-and-shadow-it-the-vba-client/) |
Find below a list of different integration options.
Integration/interface with... | Use case | Current maturity level | Comments | more Details at... | |
---|---|---|---|---|---|
email systems | Receiving emails | Additonal software needed | There is a plugin available for the [open source mail server James](http://james.apache.org/) to forward emails to ESME. Connecting with other mailservers involves development of a small piece of software, which call the ESME APIs. | [Link to docs.google.com | http://docs.google.com/Doc?id=df96bz6v_18cw9vrcwr] |
email systems | Sending emails | Out-of-the-box available | ESME sends emails based on user defined [actions](actions.html) . ESME relies for sending eMails on the JavaMail API and its required settings. | [Sending emails from ESME] | |
MS Sharepoint | Retrieving ESME conversations | Internal testcase | (needs to be documented) | ||
Yahoo Pipes | Information retrieval from other microblogging tools | Working configuration document available | Link to blog entry | http://www.esjewett.com/blog/twitter-pipes-esme] |
{display-footnotes}