Overview of the LogMeIn Rescue API

The LogMeIn Rescue API provides an interface to third parties for communicating with an application. Use this API to customize how Rescue integrates with your other support applications.

The LogMeIn Rescue API is a tool for retrieving information related to your Rescue account from the LogMeIn environment and based on that information, recreate most of the functionality that the LogMeIn Rescue Administration Center offers. This document describes the LogMeIn Rescue methods that you can use to interact with Rescue from your environment. For information about the functionality that these methods invoke, see the Rescue Administration Center User Guide.

Why would I use Rescue API?

The primary examples of why you would do this are:

Make the Administration Center functionality available from your own website
CRM Integration
Custom Reporting
Billing Integration
Customize the Administration Center

Who should read this document?

The pages related to the API are written for a technical audience. Since utilization of the API is custom in nature, the following must be considered:

Support for using the API is very limited since its usage is custom in nature
Knowledge of API, Web Service usage, and programming are required

What technology does the Rescue API support?

The Rescue API supports three methods for communication that C# and PHP programmers can use:

Communication Method Description

HTTP GET

Communication Method	Description
HTTP GET	This protocol creates a query string of the name and value pairs and then appends the query string to the URL of the script on the server that handles the request. For example, if you want to retrieve information about a technician with ID 123456, you must use the URL of the getUser API method and append the input parameter (node) at the end of the URL: `https://secure.logmeinrescue.com/API/getUser.aspx?node=123456`
HTTP POST	This protocol passes the name and value pairs in the body of the HTTP request message. For example, if you want to retrieve information about the technician with ID 123456, you must define API method you want to call (getUser) and then the name and value of the input parameter (node): `<form method="post" action="https://secure.logmeinrescue.com/API/getUser.aspx"> <input name=node value=123456> </form>`
SOAP	This protocol is used for exchanging XML messages between clients and servers. The response message can be easily parsed into a third-party system as the structure of the message is based on well-defined standards.

This protocol creates a query string of the name and value pairs and then appends the query string to the URL of the script on the server that handles the request. For example, if you want to retrieve information about a technician with ID 123456, you must use the URL of the getUser API method and append the input parameter (node) at the end of the URL:

https://secure.logmeinrescue.com/API/getUser.aspx?node=123456

HTTP POST

This protocol passes the name and value pairs in the body of the HTTP request message. For example, if you want to retrieve information about the technician with ID 123456, you must define API method you want to call (getUser) and then the name and value of the input parameter (node):

<form method="post" action="https://secure.logmeinrescue.com/API/getUser.aspx">
        <input name=node value=123456>
</form>

SOAP This protocol is used for exchanging XML messages between clients and servers. The response message can be easily parsed into a third-party system as the structure of the message is based on well-defined standards.

What samples do I get?

All PHP examples use PHP5's built-in SOAP extension.

Examples in C# are compiled for ASP.NET 2.0 compatibility, and use HttpWebRequest, which in turn uses the HTTP POST variables listed in the examples for each API method.

Where can I learn more about API programming?

There are numerous tutorials for HTML, XML, C#, and PHP programming available on the Internet that help you understand and reproduce the examples given in this document. Visit the following websites to find out more about the API programming code:

For a C# tutorial, visit http://www.csharp-station.com/Tutorial
For HTML, XML, and PHP tutorials, visit http://www.w3schools.com