API Explorer 

Two API explorers are available to help developers quickly understand and try APIs that are available for building social applications. The LotusLive API Explorer is designed to help partners develop applications that use the IBM LotusLive services that are exposed by the LotusLive Partner Platform APIs. The Social Business API Explorer provides access to APIs that are available with IBM Connections 3.0.1.

Both API explorers provide a test environment for developing social applications on IBM Lotus Greenhouse. You can make API calls, see the response of those calls, and access the documentation for those APIs - all within a single interface.

IBM LotusLive API Explorer

The API Explorer contains the following APIs:

Requirements for using the API Explorer

• Account on E1 (http://test.lotuslive.com)
• In order to get an account on E1 you must be a member of the LotusLive Business Partner program more details can be found at the following URL: https://www.lotuslive.com/en/businesspartners/index.php
• OAuth Consumer Key and OAuth Consumer Secret

Accessing and using the API explorer

1) Log-in to E1 (http://test.lotuslive.com)
2) Click on the link for LotusLive Lab in the navigation bar
3) Click on the API Explorer link
4) Then navigate to the API Explorer at the following URL: https://researcher.ibm.com/llapiexplorer/
5) Enter your OAuth Consumer Key and OAuth Consumer Secret and then click on "Get Started!"

6) Use the navigation on the right to locate the API call that you would like to try

7) Select the API call you would like to run, and provide any values requested.
8) Click on "Execute API"
9) Results will be displayed in the Response Tab



Notes:

• The API calls are executed against the E1 Test environment and as such will return results based on data on the E1 server only.
• The API Explorer only represents a subset of the available API calls.
• Developers are required to authenticate with E1, and also enter their OAuth Consumer Key and OAuth Consumer Secret .

Social Business API Explorer

The API Explorer contains the following APIs:

• Activity stream: A shared social API for developing applications that implement an activity stream, a personal view of relevant updates and events that have been aggregated from multiple sources. Similar to a news feed on a social networking site but applied to enterprise data and data sources, an activity stream is updated with new content and events as data is retrieved and published to the stream.
• People: An IBM Connections API for developing applications that use a directory of the people in your organization, including their names, contact information, technical expertise, familiarity with foreign languages, areas of interest, and more.
• Files: An IBM Connections API for developing applications that enable teams to create a shared repository of files, for example add files to a collection, read and modify existing files, and more.
• Wikis: An IBM Connections API for retrieving the Atom document of a wiki page.
• Domino data service: An API for reading views, folders and documents in a Domino database. This API also lets you create, update, and delete documents in a Domino database.

Requirements

Note the following requirement:

• A valid Lotus Greenhouse ID and password. For more information, see Lotus Greenhouse website, and click Sign Up Today in the top, right corner.

Accessing and using the API explorer

Do the following steps to use the API Explorer:

1. Navigate to the IBM Social Business API Explorer on Lotus Greenhouse. 
2. Click OnPremise.
3. Click Get Started.
4. Type your Lotus Greenhouse user ID and password, and click Log in. In the next window, select the Authorize box and then click OK, I'll allow it. This action authorizes the API Explorer to access your activity stream data on Lotus Greenhouse. A message displays to inform you that the authorization was successful.
5. Just below the message, click API Explorer.
6. Expand an API category in the left navigation bar, and click a method.
7. In the main window, on the Request tab, information about that method displays.
8. To make an API call using that method, specify values for method parameters, and click Execute API.
9. Click the Response tab to see the response of the API call.
10. For additional documentation about each API, including parameter details, click the Documentation tab.

Posting and putting Atom documents

For API methods that POST or PUT Atom documents, such as the updateProfileEntry method, do the following steps:

1. Do a GET operation using the getProfileEntry method. This operation returns an Atom representation of the user's profile.
2. Click Show Encoded on the Response tab, copy the Atom response and make modifications, if desired.
3. Paste the encoded and modified response data into the post_string parameter field of the updateProfileEntry method.