Mike.robski: 1 revision: Release 100

2014-11-19T05:09:35Z

1 revision: Release 100

Venzi.iliev: /* Service Attributes */

2014-10-20T16:24:29Z

Service Attributes

Mike.robski: 1 revision: Release 91

2014-03-11T16:58:16Z

1 revision: Release 91

Mike.robski at 16:15, 11 March 2014

2014-03-11T16:15:02Z

New page

You can order a domain name using the [[Orders|Ordering API]]. The ordering process should have the following steps. You need to create an order, create an account or set an existing account to use with the order, add a product, add service to the product, add attributes to the service and finally you need to validate the order, get a quote and submit the order. The general process is documented in the [[Orders|Ordering API]].

When creating a product, you need to use the product offering (specification) associated with the domain product, e.g.
<nowiki>
{ "offering": "http://coreapi01.ote.chicago.hostway:8100/productSpecifications/core.plan.dnr.only/offerings/USD-12" }
</nowiki>

When adding a service to the product you need to use service specification associated with domain name registration:
<nowiki>
{
"name": "ng-test-fitnesse-20130412-0840.com",
"serviceSpecification": "http://coreapi01.ote.chicago.hostway:8100/serviceSpecifications/core.dnr.com",
"billingCycle": 12
}
</nowiki>

Finally, the service needs to have attributes such as domain contacts, nameservers, registration term, etc.:

Register .com
<nowiki>
{
"domainName": "ng-test-fitnesse-20130412-0840.com",
"operation": "register",
"term": 1,
"authInfo" : "mysecret",
"nameservers" : [ "ns1.test.com", "ns2.test.com" ],
"contactInfo" : {
"registrant": {
"type": "registrant",
"firstName": "John",
"lastName": "Doe",
"company": "ACME Inc.",
"street1": "123 First Str.",
"city": "Chicago",
"zipOrPostal": "34567",
"stateOrProvince": "IL",
"countryCode": "US",
"email1": "john.doe@test.com",
"phone1": "+1.312.456789098" },
"administrative": {
"type": "administrative",
...
},
"billing": {
"type": "billing",
...
},
"technical": {
"type": "technical",
...
}
}
}
</nowiki>

Register .us
<nowiki>
{
"domainName": "ng-test-fitnesse-20130412-0840.us",
"operation": "register",
"term": 1,
"authInfo" : "mysecret",
"nameservers" : [ "ns1.test.com", "ns2.test.com" ],
"additionalParams" : { "usNexusCode": "P1", "usNexusCategory": "C11" }
"contactInfo" : {
"registrant": {
"type": "registrant",
"firstName": "John",
"lastName": "Doe",
"company": "ACME Inc.",
"street1": "123 First Str.",
"city": "Chicago",
"zipOrPostal": "34567",
"stateOrProvince": "IL",
"countryCode": "US",
"email1": "john.doe@test.com",
"phone1": "+1.312.456789098" },
"administrative": {
"type": "administrative",
...
},
"billing": {
"type": "billing",
...
},
"technical": {
"type": "technical",
...
}
}
}
</nowiki>

==== Service Attributes ====
; domainName - ''string''
: The domain name
; operation - ''string''
: "register" to register a domain
; term - ''integer''
: the registration term (period) in years
; authInfo - ''string''
: authentication info, currently not supported
; nameservers - ''list of strings''
: domain name servers (DNS) for the domain
; usNexusCode - ''string'' (optional) (required for .us)
: one of the following [P1, P2, P3, P4, P5]
; usNexusCategory - ''string'' (optional) (required for .us)
: one of the following [C11, C12, C21, C31, C32]
; company - ''string'' (optional)
: The company or organization name
; firstName - ''string''
: The first name of the contact person
; lastName - ''string''
: The last name of the contact person
; street1 - ''string''
: The street address
; street2 - ''string'' (optional)
: The second line of the street address (if any)
; city - ''string''
: The city
; countryCode - ''string''
: The international 2-letter country code
; stateOrProvince - ''string''
: The state or province. For US states use the 2-letter state code
; zipOrPostal - ''string''
: The postal code
; email1 - ''string''
: The e-mail address of the contact person
; phone1 - ''string''
: The phone number of the contact person in valid [http://en.wikipedia.org/wiki/E.164 E.164] format, e.g. +1.3209270625

== See also ==
* [[Orders|Ordering API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

@@ Line 62: / Line 62: @@
     "authInfo" : "mysecret",
     "nameservers" : [ "ns1.test.com", "ns2.test.com" ],
-    "additionalParams" : { "usNexusCode": "P1", "usNexusCategory": "C11" }
+    "extraParams": [{"name": "us_nexus", "value": "C11"}, {"name": "us_purpose", "value": "P1"}],
     "contactInfo" : {
        "registrant": {
@@ Line 98: / Line 98: @@
 : "register" to register a domain
 ; term - ''integer''
-: the registration term (period) in years
+: The registration term (period) in years
 ; authInfo - ''string''
-: authentication info, currently not supported
+: Authentication info, currently not supported
 ; nameservers - ''list of strings''
-: domain name servers (DNS) for the domain
+: Domain name servers (DNS) for the domain
-; usNexusCode - ''string'' (optional) (required for .us)
+{{ExtraParam}}
-: one of the following [P1, P2, P3, P4, P5]
-; usNexusCategory - ''string'' (optional) (required for .us)
-: one of the following [C11, C12, C21, C31, C32]
 ; company - ''string'' (optional)
 : The company or organization name

OrderingDomain - Revision history

Mike.robski: 1 revision: Release 100

Venzi.iliev: /* Service Attributes */

Mike.robski: 1 revision: Release 91

Mike.robski at 16:15, 11 March 2014