This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Nameserver generateSingleDomainTokenRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
 
(One intermediate revision not shown)
Line 3: Line 3:
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
|'''Module'''
|'''Module'''
-
|Nameserver module
+
|Single Domain DNS panel module
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
Line 14: Line 14:
|
|
*'''domain name'''
*'''domain name'''
 +
*zoneProvider (''openprovider'' or ''sectigo'', default value is ''openprovider'') - in case you have a premium DNS zone, parameter has to be specified to generate a token for it
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''

Current revision as of 03:12, 9 September 2021

Contents

Module Single Domain DNS panel > Generate token

Module Single Domain DNS panel module
Command name generateSingleDomainTokenRequest
Use Creates an access token to the single domain DNS panel
Input
  • domain name
  • zoneProvider (openprovider or sectigo, default value is openprovider) - in case you have a premium DNS zone, parameter has to be specified to generate a token for it
Output
  • token
  • url

Examples

Using PHP class

 $request = new OP_Request;
 $request->setCommand('generateSingleDomainTokenRequest')
   ->setAuth(['username' => 'username', 'password' => 'password'])
   ->setArgs([
     'domain' => 'example.com',
   ]);
 $api = new OP_API('https://api.openprovider.eu/');
 $reply = $api->process($request);


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>
   <generateSingleDomainTokenRequest>
     <domain>example.com</domain>
   </generateSingleDomainTokenRequest>
 </openXML>
 <?xml version="1.0" encoding="UTF-8"?>
 <openXML>
   <reply>
     0
     <desc></desc>
     <data>
       <token>example23charactertoken</token>
       <url>https://dnspanel.io?token=example23charactertoken</url>
     </data>
   </reply>
 </openXML>
Views
Personal tools