Summary

Some Glance We often use the word "partner" in place of "customer". customers manage their users' registration via requests into the Glance server. This can be an effective way to manage your users, especially if you have many of them. To do this, you make https requests to the Glance website. These requests are designed to be made either

• by some program on your server, or
• via requests made from the users' browsers from links or forms on pages served by your website.

You must not use unencrypted http requests; only https requests are allowed.

Operations

The API request endpoints are:

Parameters

You access the endpoints in this API using https POST requests, passing the parameters as html form field values.

NOTE: It is possible to use this API via GET requests. But we strongly discourage doing so because some parameters contain passwords. Web servers log GET requests including passwords and other parameters, which is insecure.

Authentication

When making requests to these operations you must include authentication parameters.

PartnerLogin: The Glance user name of an active administrative user. Glance assigns this user name. It is an error (see response handling below) if an unknown or inactive partner name is supplied. Notice that Glance user names are not email addresses: they look like admin.example.glance.net, not admin@example.glance.net.

PartnerPW: The password for the PartnerLogin. Either PartnerPW or PartnerAuth is required.

PartnerAuth: An alternate authentication using a time-limited LoginKey for the PartnerLogin account. See the LoginKey document for information on generating this parameter.

PartnerID: An optional parameter of the the group ID that the action is intended to take place on. If your admin user is in multiple groups, you must specify a partner ID.

Redirection

You may include URL parameters to cause the web service to redirect its client. These parameters are deprecated and may be removed in a future API release.

OKURL: (deprecated, optional) If the operation succeeds, the web service redirects its client (via a 302 status code and Redirect header) to this URL. (The NewUser operation may add parameters to this redirection URL.)

FailURL: (deprecated, optional) If the NewUser operation fails, the web service redirects its client to this URL.

Responses

Success

Upon success, operations in this web service return this XML document.

<?xml version="1.0" standalone="yes"?>
<response>
  <status>OK</status>
</response>

Failure

Upon failure, the operations in this API return an XML document like this one.

<?xml version="1.0" standalone="yes"?>
<response>
  <status>FAIL</status>
  <errcode>13001</errcode>
  <msg>Required field not supplied</msg>
  <field>PartnerLogin</field>
</response>

Possible <errcode> and <msg> values are these. If the failure relates to a parameter, its name appears in the <field> value.