API Module Domain requestAuthCodeDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Request Authorization Code) |
|||
| (3 intermediate revisions not shown) | |||
| Line 9: | Line 9: | ||
|- | |- | ||
|'''Use''' | |'''Use''' | ||
| - | |Reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send a code to the domain owner (like in case of e.g. .be | + | |Reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send a code to the domain owner (like in case of e.g. .be and .eu). If the registry does not support the retrieval of an authorization code (e.g. .se and .nu), please refer to the [[API Module Domain resetAuthCodeDomainRequest|resetAuthCodeDomainRequest]] command. |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
*'''[[API Format Domain|domain]]''' | *'''[[API Format Domain|domain]]''' | ||
| - | * | + | *[[API Format authCodeType|authCodeType]] |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 55: | Line 55: | ||
<reply> | <reply> | ||
<nowiki><code>0</code></nowiki> | <nowiki><code>0</code></nowiki> | ||
| - | <desc></ | + | </desc> |
| + | <data> | ||
| + | <authCode>3fdchdHKsHA4Ke</authCode> | ||
| + | <type>external</type> | ||
| + | </data> | ||
</reply> | </reply> | ||
</openXML> | </openXML> | ||
Current revision as of 09:01, 21 January 2021
Contents |
Module Domain > Request Authorization Code
| Module | domain |
| Command name | requestAuthCodeDomainRequest |
| Use | Reads the transfer authorization code (or EPP code) from the registry or triggers the registry to send a code to the domain owner (like in case of e.g. .be and .eu). If the registry does not support the retrieval of an authorization code (e.g. .se and .nu), please refer to the resetAuthCodeDomainRequest command. |
| Input | |
| Output |
- |
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('requestAuthCodeDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'domain' => array(
'name' => 'domain',
'extension' => 'be'
),
'authCodeType' => 'external',
));
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>
<requestAuthCodeDomainRequest>
<domain>
<name>domain</name>
<extension>be</extension>
</domain>
<authCodeType>external</authCodeType>
</requestAuthCodeDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
</desc>
<data>
<authCode>3fdchdHKsHA4Ke</authCode>
<type>external</type>
</data>
</reply>
</openXML>