Allgemein gültige XML-Keywords

API-Referenz (XML/JSON) · Aktualisiert 2023-09-06

Liste der Keywords

Keyword	Häufigkeit	Format	Veschreibung
request / owner	0 - 1		Mit dem Owner-Block kann man Aufträge als ein bestimmter Unterbenutzer durchführen.
request / owner / user	1	string	Benutzername des Unterbenutzers
request / owner /context	1	string	Personal-ID des Unterbenutzers
request /task / reply_to	0 -1	string	Kontaktadresse für unser Supportteam zur Kontaktaufnahme bei Problemen. Verpflichtend für Domain- und Domain-Kontakt-Aufträge. Für die anderen Aufträge nicht verpflichtend.
request / task / email_confirmation	0 - 1	string	Die erfolgreiche Entgegennahme des Auftrags wird per E-Mail bestätigt.
request / task /execdate	0 - 1	execdate	Zeitpunkt der Ausführung. Format: yyyy-MM-dd Dieses Keyword kann nicht für alle Auftragstypen verwendet werden.
request /task / ctid	0 - 1	string	= Client Transaction ID. Diese ID kann selbst vergeben werden und wird bei der Antwort-E-Mail wieder zurück geliefert. Auf die Art und Weise könen Vorgänge automatisiert werden. Bei einem Multitask wird die CTID in jedem „Result“-Tag zurückgegeben.
request / bulk_limit	0 -1	int	Bei Massenaufträgen werden die Aufträge vom System angenommen, in eine Bulk-Queue verschoben und von dort vom System abgearbeitet. In der Systemantwort ist für jeden enthaltenen Auftrag ein eigener „Result“-Block enthalten. Die Systemantworten können bei großen Massenaufträgen entsprechend umfangreich werden und die Verarbeitung bremsen. Der Vorgabewert von 20 Einzelaufträgen kann mit dem Keyword bulk_limit geändert werden. Die Details zu den Einzelaufträgen werden bei größeren Aufträgen dann per E-Mail verschickt.

Owner

Format

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

Beispiel

Registrierung einer Domain für einen Unterbenutzer, die ihm auch zugeordnet wird.

 <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>

Beispiel

Bestellung eines Zertifikates für einen Unterbenutzer, das ihm auch zugeordnet wird.

<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 (Antwort-Adresse)

Beispiel

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

Email Confirmation (Bestätigungs-E-Mail)

Beispiel

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

Ctid (= Client Transaction ID)

Beispiel

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

Für die Automatisierung ist die Verwendung einer eindeutigen Ctid für jeden Auftrag empfehlenswert, um die Systemantworten eindeutig zuordnen zu können. Nur die Zeichen a-z, A-z 0-9 sind erlaubt, die Ctid muss zusammenhängend, also ohne Leerzeichen sein.

Bulk_limit

Beispiel

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