Product Agreement

Purpose

Each product has agreements between the vendor and the customer. When a customer buys that product, it’s imperative that he agrees to conditions set forth by the vendor. It is considered good practice to show the customer this agreement rather than taking it for granted. This methods returns that agreement so the customer can agree to it before ordering.

LIVE URL:

https://api.thesslstore.com/rest/order/agreement

SANDBOX URL:

https://sandbox-wbapi.thesslstore.com/rest/order/agreement

HTTP VERB
POST

PARAMETERS
JSON :
Content-type: application/json; charset=utf-8;

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content",
		"IPAddress":"String content",
		"IsUsedForTokenSystem":true,
		"Token":"String content"
	},
	"CustomOrderID":"String content",
	"ProductCode":"String content",
	"ExtraProductCodes":"String content",
	"OrganisationInfo":{
		"OrganizationName":"String content",
		"DUNS":"String content",
		"Division":"String content",
		"IncorporatingAgency":"String content",
		"RegistrationNumber":"String content",
		"JurisdictionCity":"String content",
		"JurisdictionRegion":"String content",
		"JurisdictionCountry":"String content",
		"OrganizationAddress":{
			"AddressLine1":"String content",
			"AddressLine2":"String content",
			"AddressLine3":"String content",
			"City":"String content",
			"Region":"String content",
			"PostalCode":"String content",
			"Country":"String content",
			"Phone":"String content",
			"Fax":"String content",
			"LocalityName":"String content"
		}
	},
	"ValidityPeriod":2147483647,
	"ServerCount":2147483647,
	"CSR":"String content",
	"DomainName":"String content",
	"WebServerType":"String content",
	"DNSNames":["String content"],
	"isCUOrder":true,
	"isRenewalOrder":true,
	"SpecialInstructions":"String content",
	"RelatedTheSSLStoreOrderID":"String content",
	"isTrialOrder":true,
	"AdminContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"TechnicalContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"ApproverEmail":"String content",
	"ReserveSANCount":2147483647,
	"AddInstallationSupport":true,
	"EmailLanguageCode":"String content",
	"FileAuthDVIndicator":true,
	"CNAMEAuthDVIndicator":true,
	"SignatureHashAlgorithm":"String content"
}

XML:
Content-type: application/xml; charset=utf-8;

<NewOrderRequest><AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
<TokenID>String content</TokenID>
<TokenCode>String content</TokenCode>
<IPAddress>String content</IPAddress>
<IsUsedForTokenSystem>true</IsUsedForTokenSystem>
<Token>String content</Token>
</AuthRequest><CustomOrderID>String content</CustomOrderID>
<ProductCode>String content</ProductCode>
<ExtraProductCodes>String content</ExtraProductCodes>
<OrganisationInfo>
<OrganizationName>String content</OrganizationName>
<DUNS>String content</DUNS>
<Division>String content</Division>
<IncorporatingAgency>String content</IncorporatingAgency>
<RegistrationNumber>String content</RegistrationNumber>
<JurisdictionCity>String content</JurisdictionCity>
<JurisdictionRegion>String content</JurisdictionRegion>
<JurisdictionCountry>String content</JurisdictionCountry>
<OrganizationAddress>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<AddressLine3>String content</AddressLine3>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
<Phone>String content</Phone>
<Fax>String content</Fax>
<LocalityName>String content</LocalityName>
</OrganizationAddress>
</OrganisationInfo>
<ValidityPeriod>2147483647</ValidityPeriod>
<ServerCount>2147483647</ServerCount>
<CSR>String content</CSR>
<DomainName>String content</DomainName>
<WebServerType>String content</WebServerType>
<DNSNames>
<string>String content</string>
<string>String content</string>
</DNSNames>
<isCUOrder>true</isCUOrder>
<isRenewalOrder>true</isRenewalOrder>
<SpecialInstructions>String content</SpecialInstructions>
<RelatedTheSSLStoreOrderID>String content</RelatedTheSSLStoreOrderID>
<isTrialOrder>true</isTrialOrder>
<AdminContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</AdminContact>
<TechnicalContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</TechnicalContact>
<ApproverEmail>String content</ApproverEmail>
<ReserveSANCount>2147483647</ReserveSANCount>
<AddInstallationSupport>true</AddInstallationSupport>
<EmailLanguageCode>String content</EmailLanguageCode>
<FileAuthDVIndicator>true</FileAuthDVIndicator>
<CNAMEAuthDVIndicator>true</CNAMEAuthDVIndicator>
<SignatureHashAlgorithm>String content</SignatureHashAlgorithm>
</NewOrderRequest>

RESPONSE
JSON :

{
	"Agreement":"String content",
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	}
}

XML:

<UserAgreementResponse>
<Agreement>String content</Agreement>
<AuthResponse>
<isError>true</isError>
<Message>
<string>String content</string>
<string>String content</string>
</Message>
<Timestamp>String content</Timestamp>
<ReplayToken>String content</ReplayToken>
<InvokingPartnerCode>String content</InvokingPartnerCode>
</AuthResponse>
</UserAgreementResponse>

Fields Explanation:
• R – Required
• O – Optional
• I – Ignore (not applicable)

NAME FROM Field Req. Type Description
AuthRequest.PartnerCode Request R string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

Optional if Token is specified.

AuthRequest.AuthToken Request R string This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.

Optional if Token is specified.

AuthRequest.ReplayToken Request O string This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request O string User Agent to identify the request coming from.
AuthRequest.IsUsedForTokenSystem Request R Boolean There are only two possible values true or false. This field mainly used by AutoInstallSSL Plugin.
AuthRequest.Token Request R* string This is an alpha-numeric code.

* This is Required only if you have set IsUsedForTokenSystem is true.

NewOrderRequest.AddInstallationSupport Request I Boolean If reseller would like to purchase Installation support along with order. They have to pass True. Default value is false.
NewOrderRequest.ApproverEmail Request I String This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.
NewOrderRequest.CSR Request I String Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)
NewOrderRequest.CustomOrderID Request I String A Unique Number Provided by You.
NewOrderRequest.DomainName Request I String The domain name for an Order. For an SSL Order this can be a fully qualified Domain (e.g., www.thesslstore.com) or possibly a wildcard domain (e.g., *.geotrust.com).
*Required for this request.
NewOrderRequest.EmailLanguageCode Request I String The language code to be used when sending e-mail messages for this order. (right Now is not supported) Default Value is “EN”.
NewOrderRequest.FileAuthDVIndicator Request I Boolean This value shows whether DV file authentication process is available or not.
NewOrderRequest.SignatureHashAlgorithm Request I String Defines hashing algorithm for certificate.
NewOrderRequest.ExtraProductCodes Request I String Comma separated product code for free products, like trust logo.
NewOrderRequest.isCUOrder Request I Boolean The IsCUOrder is the validated CU results for a specified order.
NewOrderRequest.isRenewalOrder Request I Boolean Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request I Boolean Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request R String A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
NewOrderRequest.RelatedTheSSLStoreOrderID Request I String Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.
NewOrderRequest.ReserveSANCount Request I String Allows a partner to limit the number of values that a customer can enter in the SAN Field of a certificates.
NewOrderRequest.ServerCount Request R String Number of Server Licenses.
NewOrderRequest.SpecialInstructions Request I String Special Instructions for the order.
NewOrderRequest.ValidityPeriod Request R String Validity Period (in months)
NewOrderRequest.WebServerType Request I String This is from the Order Parameters structure. Designates the type of web server that an order is targeted for.
OrganisationInfo.Division Request I String The Organizational Unit name from the CSR. Up to three comma-separated values may be contained in this parameter.
OrganisationInfo.DUNS Request I String The DUN and Bradstreet number for a company.
OrganisationInfo.IncorporatingAgency Request I String Incorporating Agency Name.
OrganisationInfo.JurisdictionCity Request I String Jurisdiction City Name.
OrganisationInfo.JurisdictionCountry Request I String Jurisdiction of Incorporation: Country.
OrganisationInfo.JurisdictionRegion Request I String Jurisdiction Region Name.
OrganisationInfo.OrganizationName Request I String The name of the Organization applying for the product. This applies to Organization Vetted products.
OrganisationInfo.RegistrationNumber Request I String Company Registration Number.
OrganizationAddress.AddressLine1 Request I String Organization Street AddressLine1.
OrganizationAddress.AddressLine2 Request I String Organization Street AddressLine2.
OrganizationAddress.AddressLine3 Request I String Organization Street AddressLine3.
OrganizationAddress.City Request I String Organization City Name.
OrganizationAddress.Country Request I String Organization Country Name.
OrganizationAddress.Fax Request I String Organization Fax Number.
OrganizationAddress.LocalityName Request I String The Locality field from the CSR or Certificate.
OrganizationAddress.Phone Request I String Organization Phone Number.
OrganizationAddress.PostalCode Request I String Organization Postal Code.
OrganizationAddress.Region Request I String Organization Region Name.
TechnicalContact.AddressLine1 Request I String Technical Contact Street AddressLine1.
TechnicalContact.AddressLine2 Request I String Technical Contact Street AddressLine2.
TechnicalContact.City Request I String Technical Contact City Name.
TechnicalContact.Country Request I String Technical Contact Country Name.
TechnicalContact.Email Request I String Technical Contact Email Address.
TechnicalContact.Fax Request I String Technical Contact Fax Number.
TechnicalContact.FirstName Request I String Technical Contact First Name.
TechnicalContact.LastName Request I String Technical Contact Last Name.
TechnicalContact.OrganizationName Request I String Technical Contact Organization Name.
TechnicalContact.Phone Request I String Technical Contact Phone Number.
TechnicalContact.PostalCode Request I String Technical Contact Postal Code.
TechnicalContact.Region Request I String Technical Contact Region Name.
TechnicalContact.Title Request I String Technical Contact Person’s title.
UserAgreementResponse.Agreement Response N/A String User Agreement string
AuthResponse.isError Response N/A Boolean Returns False/true according to errorstatus into the response.
AuthResponse.Message Response N/A String The Message given into the response.
AuthResponse.Timestamp Response N/A Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response N/A String The value of the ReplayToken which provide by you in Order request.
AuthResponse.InvokingPartnerCode Response N/A String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.