Input Parameters

Return Value

Faults

Create a "restricted" token from a login token. A restricted token has
a restriction stored in it such that it cannot be used except to access
the specified resource(s).
The available restrictions should be documented with the API endpoint that
supports them.

Input Parameters

name

description

token

Login auth token (without any restriction set)

restriction

Restriction string; the format depends on the operation the token is intended for use with

duration

Expiry time for the restricted token

Return Value

A new AuthToken with a restriction set

Faults

Exchange a string returned by encodeAuthToken for the original
AuthToken structure for use in API calls. If you have implemented
a URL endpoint that accepts a parameter that is a string auth token
then this can be used to convert that opaque string back into a
transparent structure.

Exchange an AuthToken for a string referencing that AuthToken. The string
can then be put onto the end of certain URLs in order to make those URLs
"authenticated" URLs not requiring login to access. This is useful for
generating links in a web page or email that the user clicks on to download
a report, attachment, or PDF.

Input Parameters

Return Value

Faults

Get an exchange rate from the server so that it can be populated into a record
as a reasonable "default" for the user.
Note that this call should not be used to provide data for your own third-party
systems; it must only be used as a convenience method to fill in exchange rates
as a default which are then saved back into our system.
This API is not to be used as a general source of exchange rate data.