M2 API user login

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API Logs in user into MOR

[edit] Usage

  • For Backwards-compatibility old name 'login' is also usable. Call: /api/login
  • Methods: POST, GET(if allowed, not recomended)



[edit] Parameters

  • u - username to login. Required.
  • p - Password to login. Required.



[edit] Request

HTML POST: http://<SERVER_IP>/billing/api/user_login?u=username&p=password

[edit] Returns

Success. Everything is ok. User is logged into the system you get:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <action>
   <name>login</name>
   <status>ok</status>
   <user_id>user_id</user_id>    #this line was added on MOR11
   <status_message>Successfully logged in</status_message>
 </action>

Error

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <action>
   <name>login</name>
   <status>failed</status>
   <status_message>Login failed</status_message>
 </action>

This means that wrong username and/or password and user can't be authenticated.

[edit] Advanced options

To redirect customer to MOR Billing main site go to: SETTINGS -> Setup -> Settings -> API and check the marked option:

File:Mor_api_redirect.png

If login over API is successful the customer will be redirected to MOR Billing main site.

If login is not successful :

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <action>
   <name>login</name>
   <status>failed</status>
 </action>

This means that wrong username and/or password and user can't be authenticated.

[edit] See also

Personal tools

Try MOR

Try M2