API Module SpamExperts generateSeLoginUrlRequest

From Openprovider API documentation

Jump to: navigation, search

Contents

Module SpamExperts > Generate Login URL

Module SpamExperts
Command name generateSeLoginUrlRequest
Use Returns an url that can be used for logging in to the SpamExperts control panel. If you want you can whitelabel the hostname by taking the auth at the end of the URL and replacing the part in front of it by your own URL, as long as it leads to our platform via DNS.
Input
  • domainOrEmail
  • bundle (0 or 1. If you use the new, individually purchased, filters then set this to 0. If you use the old bundled variant, then set this to 1.)
Output
  • url

Examples

Using PHP class

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

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>
    <bundle>1</bundle>
  </generateSeLoginUrlRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <url>http://spamexperts.openprovider.eu//?authticket=086ee798cfa3c6af0123553cfd4774757223fdfe</url>
    </data>
  </reply>
</openXML>
Views
Personal tools