API Module Authentication

From Openprovider API documentation

(Difference between revisions)

Current revision as of 06:03, 10 June 2016

Authentication

Module	authentication
Command name	none
Use	Each API call requires authentication. This can be with a plain text password, or a password hash. To get the password hash, or to reset the password hash, please visit the reseller control panel, section contact details (Go from menu: Account -> Account overview -> 'Click on the desired contact' -> Show password hash).
Input	username password (only required if no hash is provided) hash (only required if no password is provided)
Output	In case of invalid credentials or hash customer gets error 196: "Authentication/Authorization Failed"

Examples

Using PHP class

// Plain text password
$request = new OP_Request;
$request->setCommand('createCustomerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
    ...
 ));

// Hashed password
$request = new OP_Request;
$request->setCommand('createCustomerRequest')
 ->setAuth(array('username' => 'username', 'hash' => '2e1b1611c1e1dba5174ad4cfd1f3b3bd6'))
 ->setArgs(array(
    ...
 ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

Request: Plain text password

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  ...
</openXML>

Request: Hashed password

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <hash>2e1b1611c1e1dba5174ad4cfd1f3b3bd6</hash>
  </credentials>
  ...
</openXML>

Response: in case if credentials are incorrect

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>196</code>
    <desc>Authentication/Authorization Failed</desc>
    <data/></reply>
</openXML>

@@ Line 3: / Line 3: @@
 |- style="background-color:#BBBBBB;"
 |'''Module'''
-|''general''
+|''authentication''
 |- style="background-color:#EEEEEE;"
 |'''Command name'''