GeoTrust API Quick Guide

Transcription

1 API Quick Guide

2 API Quick Guide Table of Contents : Overview... : Using s API... : Organization Authenticated Certificates... : Domain Authenticated Certificates... 6 : QuickInvite Ordering Scenario : QuickOrder Ordering Scenario... 8 GT

3 API Quick Guide : Overview The Partner Program offers hosting companies and resellers the ability to sell and VeriSign products directly from their website. s API allows partners to order certificates on behalf of their customers and brand the entire ordering process. This can help Partner Program partners save time and reduce costs, and allows their customers to order SSL certificates on demand x7. The Partner Program offers a flexible and powerful Simple Object Access Protocol (SOAP) API for its partners to order and manage their SSL offerings directly from their site. s API allows partners to automate both order placement and certificate management on behalf of their customers. Partners can perform functions such as ordering different products, canceling and fulfilling orders, resending order s and querying for order data. Automating these functions can reduce costs by eliminating the need to manually enter orders and reducing the number of first level support calls. As an alternative, the Partner Program also offers a POST API. With the POST API partners can submit and modify existing orders and resend order s automatically. The POST API is a great alternative for partners who do not have knowledge of SOAP or are just looking for a quick way to automate and brand order processing. The remainder of this document provides an overview of the different ordering scenarios based on the type of SSL certificates being ordered along with details of the SSL provisioning process via the API. GT

4 API Quick Guide : Using the API Using the API offers additional workflow flexibility beyond the basic UI-based ordering flow. Utilized in conjunction with selectively enabling or disabling different automated communications to a customer, a Partner Program partner can perform varying levels of the ordering workflow. This allows the integration with to be tailored to best suit the needs of the partner s overall provisioning process. Ordering state changes for SSL certificates and server web identity products are asynchronous - an API client initiates an order and then later checks the server for the completed order after the authentication process has been completed. The general approach for an API client is to () place orders, then () periodically query the API server for all orders that have changed status during a specified time interval (for example, the last four hours) using the GetModifiedOrders operation (see Figure ). This returns a list of all orders and detailed order information for those orders that have changed status in the specified time interval. The status of all returned orders can then be updated locally and used as necessary. An alternative to the general approach is to specifically request the status of a specific order. In this case, the ordering flow consists of the following operations: () place an order, and then () periodically check the status of the specific order (GetOrderByPartnerOrderID). Once the order has been completed, the fulfillment information is returned with the GetOrderByPartnerOrderID operation. This approach is generally less efficient, but might be more appropriate when there is a low volume of certificates being managed. SSL certificates fall into one of two provisioning types, domain authentication or organization authentication. Domain Authenticated products include (QuickSSL Premium and Power Server ID) and Organization Authenticated products include True BusinessID and True BusinessID with EV. VeriSign Organization Authenticated products (Secure Site, Secure Site Pro, Secure Site with EV, Secure Site with EV Pro) are also available. The following subsections describe in detail how the API is used for Organization Authenticated and Domain Authenticated SSL certificates. Partner Figure GT

5 API Quick Guide : Organization Authenticated Certificates Organization Authenticated Certificates include products where the organizational information is validated before issuing the certificate. True BusinessID and True BusinessID with EV and VeriSign Secure Site, Secure Site Pro, Secure Site with EV and Secure Site Pro with EV products fall into this category. In general, the order is submitted and is queued while the certificate is authenticated. Once the authentication process is complete, the order is fulfilled.. UI-Based Organization Authenticated Product Ordering Scenario With Organization Authentication only, validation of the Organizational data submitted with the order is also performed before the certificate is issued. True BusinessID and VeriSign Secure Site, Secure Site Pro, Secure Site with EV, and Secure Site Pro with EV certificates are Organization Authenticated products where the organization and domain authentication are done using VeriSign s authentication practices.. supplies the CSR, organization information, and the order contact information. then accepts the subscriber agreement and submits the order.. An acknowledgement is sent to the requestor and other order contacts confirming placement of the order.. Customer sends corporate documents and other information necessary to verify the organization to the or VeriSign authentication team. This may be an iterative process with or VeriSign sending out requests for additional information.. Verification call is placed to the Organization Contact by our VeriSign authentication team (for VeriSign branded products only).. Once all the authentication steps have been successfully completed, the certificate is issued.. UI-based Domain and Organization Authenticated Product Ordering Scenario With Domain and Organization Authentication, extensive validation of the requestor s Organizational information is also performed before completing a product order. True BusinessID with Extended Validation is a Domain and Organization Authenticated product.. supplies the CSR, organization information, and the order contact information. then chooses an Approver , accepts the subscriber agreement and submits the order.. An acknowledgement is sent to the requestor and other order contacts confirming placement of the order.. Customer sends corporate documents and other information necessary to verify the organization. This may be an iterative process with team sending out requests for additional information. 6. An is sent to the Approver requesting that the Approver review the submitted order. 6. The Approver follows the link in the , reviews the order information and either approves or rejects the order. 7. Upon completion of the authentication and approval process, the organization and tech contact receive the certificate via . Approver GT

6 API Quick Guide : Domain Authenticated Certificates This section defines the order initiation operations for the Domain Authenticated SSL products such as QuickSSL Premium and Power Server ID. Partners that leverage the API can completely remove themselves from the ordering process and offer their customers a solution to get an SSL certificate on demand x7.. The Domain Authentication Process domain authenticated certificates are the lowest form of authentication available. An entity requesting a domain authenticated certificate will go through a process to help verify that they either own the domain requested or that they have the right to use that domain name. Additionally we will verify that the address for the contact requesting the certificate is either listed in the WHOIS directory or meets the CA's predetermined alias requirements. Because domain registrar databases are online, this process can be completely automated.. UI-based Domain Authenticated Product Ordering Scenario s patented Domain Authentication process ensures that a registered contact for a domain approves a request for a server product for that domain. QuickSSL Premium, Power Server ID, Power Server ID Wildcard are products that are Domain Authentication. The Web based ordering process for requesting, approving and issuing certificates is described below:. supplies the CSR, organization information, and order contact information. then chooses an Approver , accepts the subscriber agreement and submits the order.. An acknowledgement is sent to the requestor and other order contacts confirming placement of the order.. An is sent to the Approver requesting that the Approver review the submitted order.. The Approver follows the link in the , reviews the order information and either approves or rejects the order.. If the order is approved, the requestor receives the certificate via . Approver 6 GT

7 API Quick Guide : QuickInvite Ordering Scenario The API-based invitation approach allows a partner to invite an end customer to place an order. Using this approach, the partner specifies a subset of the end customer s (the ) information needed to place an order. This scenario is especially useful when the partner has some information for the order, but desires the requestor to provide the remaining details or perform the order submittal action. The following steps outline the partner invitation scenario:. Partner Program partner uses the QuickInvite command, optionally supplying some order information for the.. The receives an Invite message that contains a special link to the customized order form.. The follows the link to the site and completes the order. Data that has been pre-supplied by the partner cannot be modified (for security purposes), so the partner has as much control over the order as they would like to enforce (the certificate validity period, server count, etc.). The supplies any remaining required information (Contact Info, CSR, etc). The selects one of the approvers (for domain authenticated products and True BusinessID with EV only), reviews the subscriber agreement, and submits the order.. Upon order submission, an is sent to the Approver (for domain authenticated products and True BusinessID with EV only), notifying them of an order that has been submitted and is awaiting approval.. The Approver follows the link in the to the site, and upon review, either approves or rejects the order (for domain authenticated products and True BusinessID with EV only). For Organization Authenticated certificates, our authentication team completes the necessary steps to validate the data submitted with the order). 6. Upon approval, the certificate is issued. 7. The partner receives the updated order status and information by performing the GetModifiedOrders, GetOrdersByDateRange, or GetOrderByPartnerOrderID operation. 7 6 Partner Approver 7 GT

8 API Quick Guide 6: QuickOrder Ordering Scenario If a partner collects all of the information necessary to place an order, the order can be placed on behalf of the end customer. In this approach, there are two main steps: collecting the data needed to place the order, and the actual processing of the order. 6. Collecting and Validating Order Data The collection and validation of all fields needed to place an order can be non-trivial. A good way to collect and validate this information is as follows:. The ValidateOrderParameters operation can be used to validate the CSR and other information, like renewal benefits and eligibility for competitor trade-in benefits. In addition, the domain name is returned.. Using the returned Domain Name, for domain authenticated and True BusinessID with EV orders, GetQuickApproverList is used to retrieve the list of valid approver addresses and the subscriber agreement so this information can be displayed to the person placing the order. Partner 6. Processing the Order Once the order information is ready for processing:. Partner Program partner uses the QuickOrder command to submit all order information including organization info, contact info, the CSR and the approver (for applicable products only). The approver address is required, and must be one that that is authorized to approve the order.. The remainder of the ordering process is like the UI-based ordering scenarios. An acknowledgement is sent to the requestor and other order contacts confirming placement of the order.. For products that require Organization Authentication, a or VeriSign representative may contact the Organization Contact to obtain appropriate corporate documents and other information necessary to verify the organization.. An is sent to the Approver requesting that the approver review the submitted order (for domain authenticated and True BusinessID with EV products only).. The Approver follows the link in the , reviews the order information and either approves or rejects the order (for domain authenticated and True BusinessID with EV products only). 6. Upon completion of the authentication and approval process, the certificate is issued via The partner receives the updated order status and information by performing the GetModifiedOrders, GetOrdersByDateRange, or GetOrderByPartnerOrderID operation. 7 6 Partner Approver 007, Inc. All rights reserved., the logo, the design, QuickSSL, and other trademarks, service marks, and designs are registered or unregistered trademarks of, Inc. and its subsidiaries and affiliates in the United States and in foreign countries. VeriSign is a trademark of VeriSign, Inc and its subsidiaries and affiliates in the United States and in foreign countries. All other trademarks are property of their respective owners. 8 GT