General XML keywords

API reference (XML/JSON) · Updated 2023-09-12

Keyword list

Keyword	Occurs	Format	Description
request / owner	0 - 1		With the owner block you can carry out requests for a subuser.
request / owner / user	1	string	Username of the subuser
request / owner /context	1	string	ID of the personalized system of the subuser
request /task / reply_to	0 -1	string	Contact address for our support team in case of errors. Required for domain and domain contact requests. Not required for the other requests.
request / task / email_confirmation	0 - 1	string	The successful receipt of the request will be confirmed via email.
request / task /execdate	0 - 1	execdate	Time of execution. Format:yyyy-MM-dd Please note, that this key is not valid for all tasks.
request /task / ctid	0 - 1	string	= Client Transaction ID. Ctid allows you to automate procedures, because email replies always include the CTID. In a multitask you can find it in each result tag.
request / bulk_limit	0 -1	int	Bulk request means that tasks are received, forwarded in a bulk queue and processed from there. The system answer contains one “result” block for each request. Large bulk requests cause long system message which slow down processing. For this reason the bulk_limit key is useful. If a bulk request contains more than 20 requests the system only sends a short confirmation message. All further details are sent via email.

Owner

Format

...
<owner>
	<user>customer</user>
	<context>4</context>
</owner>
<task>
	<code></code>
	<object></object>
</task>

Example

Registering a domain for a subuser, which will be assigned to this user.

 <request>
 	<auth>
 		<user>customer</user>
 		<password>password</password>
 		<context>4</context>
 	</auth>
 	<owner>
 		<user>customer2</user>
 		<context>4</context>
 	</owner>
 	<task>
 		<code>0101</code>
 		<domain>
 			<name>example.com</name>
 			<ownerc>9925346</ownerc>
 			<adminc>9925346</adminc>
 			<techc>9925346</techc>
 			<zonec>9925346</zonec>
 			<nserver>ns1.example.com</nserver>
 		</domain>
 		<reply_to>customer@example.com</reply_to>
 	</task>
 </request>

Example

Ordering a certificate for a subuser, which is also assigned to him.

<request>
 	<auth>
 		<user>customer</user>
 		<password>password</password>
 		<context>4</context>
 	</auth>
 	<owner>
 		<user>customer2</user>
 		<context>4</context>
 	</owner>
 	<task>
 		<code>400101</code>
 		<certificate>
 			<admin>
 				<id>14</id>
 			</admin>
 			<technical>
 				<id>14</id>
 			</technical>
 			<name>example.com</name>
 			<approver_email>admin@example.com</approver_email>
 			<product>SSL123</product>
 			<lifetime>12</lifetime>
 			<expire>2015-05-11 23:49:00</expire>
 			<software>APACHESSL</software>
 			<csr>
 				-----BEGIN CERTIFICATE REQUEST-----
 				PIIC4zCCAcsCAQAwgZ0xCzAJBgNVBAYTAkRFMRMwEQYDVQQIDApPcGVycG
 				Z1bHR6MRUwEwYDVQQHDAxSZWdlbnNjaGJ1cmcxEjAQBgNVBAoMCUludGVy
 				bmV0WDEUMBIGA1UECwwLRW50d2lja2x1bmcxFzAVBgNVBAMMDnd3dy50ZX
 				N0MTIzLmRlMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXN0MTIzLmRlMIIBI
 				jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxqO+nSNNzA71zVvY0kcv
 				JULQUWFkRXLWjlCvhHOidqyX1znC5E9n9JepxEhxU4gVjSc2+2IfmIMtzMa
 				9Sv+JT0xJb6TFsChKx6Xq2S9UMzaywQdnk6UOv8nr0OTz4YT1jG2Zj2HN/
 				erEsJ61ReQTWiB7cgerJQolv9PSgG1GMHe9wRJ57m0aob90T5'udoj6Df4Mi
 				LgEuXJzITH5XHwJdWsDvkmAGrARasxcAVRDfZXE2eQHQPS+8tOfooiHncqzW
 				Cr+qA+oEhfD2MCDTyZLXvguFnxqLDxvTwefALaNCp5n93Ook3IZPACV4rMoQ
 				Z5o8k/GM/QJmUtll1apuyMhfwIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEBA
 				L1E2RR2FC85pf7y2qLbAJ8GjTHW5tLK6j0YqfFQEvicBdc+aPoguo/0xWg6U
 				T4VYJVBHYZ1zdfeED5JfRs5J1TRo9TzEr67tZ00We2n+NaOitKclnPfAjt/u
 				GccZmL6zzm1VajDMf1b8zxEw+aejq/KqJOgLwFYsq7HeGiZG+KNmf7Rtvu+T
 				ZGU326+k0GL1i5jRdDUEkrrg/56rzKtVC5gs9ndSZ6UNYePe2x9sHCxzHrL5
 				OgsFTnddKFMf7X+tBRZF2QKYHQ1TtHnhIClNRis8foiTFj7wP8z8desiWYAi
 				jWXwHEMIQ4UuP8KuB2M6MO+fM+gd6K8HvPkCk6C9dQ=
 				-----END CERTIFICATE REQUEST-----
 			</csr>
 			<subject_alternative_name>
 				<name>www.example.com</name>
 				<approver_email>customer@examle.com</approver_email>
 				<order_id></order>
 			</subject_alternative_name>
 			<subject_alternative_name>
 				<name>www.example1.com</name>
 				<approver_email>customer@example.com</approver_email>
 				<order_id></order>
 			</subject_alternative_name>
 			<subject_alternative_name>
 				<name>www.example2.com</name>
 				<approver_email>customer@example.com</approver_email>
 				<order_id></order>
 			</subject_alternative_name>
 		</certificate>
 	</task>
 </request>

Reply to

Example

<task>	    
	<reply_to>customer@example.com</reply_to>	  
</task>

Email confirmation

Example

<task>	    
    <email_confirmation>customer@example.com</email_confirmation>  
</task>

Ctid (= client transaction id)

Example

<task>	    
     <ctid>123456</ctid>  
</task>

Use a unique Ctid for each order to be able to assign the system responses unambiguously. Use only the characters a-z, A-z 0-9. The Ctid must be contiguous, i.e. without spaces. The use of a Ctid is useful and recommended for automation.

Bulk_limit

Example

<task>	    
     <bulk_limit>100</bulk_limit>  
</task>