API Module SpamExperts generateSeLoginUrlRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:16, 23 March 2012

Module SpamExperts > Generate Login URL

Module	SpamExperts
Command name	generateSeLoginUrlRequest
Use	Returns a code that can be used for logging in to the SpamExperts control panel. By default, this code should be appended after the URL http://spamexperts.openprovider.eu/?authticket=. Usage of your own hostname is possible.
Input	domainOrEmail
Output	url

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('generateSeLoginUrlRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domainOrEmail' => 'newfilter.nl',
  ));

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.

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

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <url>3b42993ef9e0cf732bc400ec04bce0720a81c1fc</url>
    </data>
  </reply>
</openXML>

@@ Line 30: / Line 30: @@
 ===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.''
   <?xml version="1.0" encoding="UTF-8"?>
   <openXML>