API Call XML Package
  • 1 Minute to read
  • Dark
    Light

API Call XML Package

  • Dark
    Light

All API function calls use a standard framework for XML arguments that are passed through to each function. Below is an example of that XML framework.

<SmarterU>
   <AccountAPI></AccountAPI>
   <UserAPI></UserAPI>
   <Method></Method>
   <Parameters></Parameters>
</SmarterU>

Account API

The <AccountAPI> tag is used to identify your account when calling the API. This key is a one-way encrypted key and must be included in every API call.

In order for the account API key to be available, API access must be enabled for your account.

To find your account API key:

  1. Log into SmarterU.
  2. From the Admin menu, select Account Admin
  3. Select Account Settings.
  4. Expand the API Setup accordion. Your account's API key displays in the API Key field.

User API

The <UserAPI> tag is used to identify the caller of the API. Any actions taken through the API will be linked back to the user making the API call. This key is also a one-way encrypted key and must be included in every API call.

We recommend that you create a new user and NOT use an existing user that is associated with a person.

To obtain the UserAPI token:

  • Be sure that API is enabled for your account.
  • Create a user for the API and enable the API for that user. Doing this exposes the API key.

Method

The <Method> tag is the name of the method you wish to call within the API. For example:

<Method>createHistoricalSession</Method>

Refer to the API Methods page for a list of available methods.

Parameters

The <Parameters> tag is used to pass through the specific arguments needed for each of the API functions. Each block of XML in this tag is unique to each method. Refer to each method's page for details on its available parameters.


Was this article helpful?


What's Next