Login

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/login

Description

Authenticates the user in the system and returns the API token that is required for all other API calls.

Request

  • login [varchar]
  • password [varchar]

Response

  • status [int]: returns 1 when successful or 0 when unsuccessful. If successful returns the apiKey and if unsuccessful returns the error description.
  • apiKey [varchar]: the token that will be used for subsequent API calls.
  • error [varchar]: the error description if the login is unsuccessful.

Example

Request

     http://<wms-url>/api/login?login=myuser@vertical-tech.com&password=mypassword

Response

Successful
     {"apiKey":"YOUR_TOKEN","status":1}
Unsuccessful
     {"error":"Invalid Credentials","status":0}

Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox