Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments

URI

system/apikey

HTTP Method

Post

Request parameters

Name

Location

Type

Description

environmentNameOrURL

query

string

The identifier for the environment in which to log in

This can be:

the name of the environment
one of the values entered in the URLs setting of the environment
the full URL to the backoffice (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx )

userName

body

string

The user to log in with.
This user needs to exist in the specified environment.

password

body

string

The user's password.
This can be provided as a MD5 encoded string (which of course is the preferred method)

HTTP Return Status

Created

Returns

loginResult

Browser not supported