Main Page

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→License Module)
 
(72 intermediate revisions not shown)
Line 1: Line 1:
= Welcome to the Openprovider documentation pages =
= Welcome to the Openprovider documentation pages =
-
On those pages, documentation can be found about integration of the Openprovider API in your own systems. Changes to the documentation will be tracked in the [[API General Changelog|changelog]]. A list of release notes (releases, new features, bugfixes) can be found in the [[API General Release Notes|release notes]].
+
On those pages, documentation can be found about integration of the Openprovider API in your own systems. Changes to the documentation will be tracked in the [[API General Changelog|changelog]]. <!--A list of release notes (releases, new features, bugfixes) can be found in the [[API General Release Notes|release notes]].-->
==How to use the API==
==How to use the API==
Line 6: Line 6:
*[[API General Howto|How it works]]
*[[API General Howto|How it works]]
*[[API General Introduction|Step by step start guide]]
*[[API General Introduction|Step by step start guide]]
 +
*[[API General Examples|Examples]]
==API Commands==
==API Commands==
===Authentication===
===Authentication===
 +
Each API call requires authentication, either via password or password hash.
*[[API Module Authentication|ApiAuthentication]]
*[[API Module Authentication|ApiAuthentication]]
===Customer Module===
===Customer Module===
-
Managing your own customers for use as domain or other contacts.
+
Methods to manage customers data in your reseller account. Every customer created in our system gets unique identifier or customer handle. Customer handles are used throughout the whole system in all product modules (domains, SSL, licenses etc).
*[[API Module Customer searchCustomerRequest|searchCustomerRequest]]
*[[API Module Customer searchCustomerRequest|searchCustomerRequest]]
*[[API Module Customer retrieveCustomerRequest|retrieveCustomerRequest]]
*[[API Module Customer retrieveCustomerRequest|retrieveCustomerRequest]]
Line 20: Line 22:
===Domain Module===
===Domain Module===
-
Requesting domain statuses and managing your existing and new domains.
+
Methods to manage domains in your reseller account
*[[API Module Domain searchDomainRequest|searchDomainRequest]]
*[[API Module Domain searchDomainRequest|searchDomainRequest]]
 +
*[[API Module Domain suggestNameDomainRequest|suggestNameDomainRequest]]
*[[API Module Domain retrieveDomainRequest|retrieveDomainRequest]]
*[[API Module Domain retrieveDomainRequest|retrieveDomainRequest]]
*[[API Module Domain checkDomainRequest|checkDomainRequest]]
*[[API Module Domain checkDomainRequest|checkDomainRequest]]
Line 31: Line 34:
*[[API Module Domain deleteDomainRequest|deleteDomainRequest]]
*[[API Module Domain deleteDomainRequest|deleteDomainRequest]]
*[[API Module Domain restoreDomainRequest|restoreDomainRequest]]
*[[API Module Domain restoreDomainRequest|restoreDomainRequest]]
-
*[[API Module Domain tryAgainDomainRequest|tryAgainDomainRequest]]
+
*[[API Module Domain retrievePriceDomainRequest|retrievePriceDomainRequest]]
*[[API Module Domain approveTransferDomainRequest|approveTransferDomainRequest]]
*[[API Module Domain approveTransferDomainRequest|approveTransferDomainRequest]]
*[[API Module Domain requestAuthCodeDomainRequest|requestAuthCodeDomainRequest]]
*[[API Module Domain requestAuthCodeDomainRequest|requestAuthCodeDomainRequest]]
*[[API Module Domain resetAuthCodeDomainRequest|resetAuthCodeDomainRequest]]
*[[API Module Domain resetAuthCodeDomainRequest|resetAuthCodeDomainRequest]]
 +
*[[API Module Domain retrieveAdditionalDataDomainRequest|retrieveAdditionalDataDomainRequest]]
 +
*[[API Module Domain retrieveCustomerAdditionalDataDomainRequest|retrieveCustomerAdditionalDataDomainRequest]]
 +
*[[API Module Domain tryAgainDomainRequest|tryAgainDomainRequest]]
 +
*[[API Module Domain sendFoa1DomainRequest|sendFoa1DomainRequest]]
 +
<!--*[[API Module Domain createDomainForwardingRequest|createDomainForwardingRequest]]-->
 +
<!--*[[API Module Domain modifyDomainForwardingRequest|modifyDomainForwardingRequest]]-->
 +
<!--*[[API Module Domain searchDomainForwardingRequest|searchDomainForwardingRequest]]-->
 +
<!--*[[API Module Domain deleteDomainForwardingRequest|deleteDomainForwardingRequest]]-->
===Extension Module===
===Extension Module===
-
Finding information about the domain extensions in Openprovider.
+
Methods to get more info around domain extensions (TLDs)
*[[API Module Extension searchExtensionRequest|searchExtensionRequest]]
*[[API Module Extension searchExtensionRequest|searchExtensionRequest]]
*[[API Module Extension retrieveExtensionRequest|retrieveExtensionRequest]]
*[[API Module Extension retrieveExtensionRequest|retrieveExtensionRequest]]
Line 57: Line 68:
*[[API Module Nameserver searchZoneDnsRequest|searchZoneDnsRequest]]
*[[API Module Nameserver searchZoneDnsRequest|searchZoneDnsRequest]]
*[[API Module Nameserver retrieveZoneDnsRequest|retrieveZoneDnsRequest]]
*[[API Module Nameserver retrieveZoneDnsRequest|retrieveZoneDnsRequest]]
 +
*[[API Module Nameserver searchZoneRecordDnsRequest|searchZoneRecordDnsRequest]]
*[[API Module Nameserver createZoneDnsRequest|createZoneDnsRequest]]
*[[API Module Nameserver createZoneDnsRequest|createZoneDnsRequest]]
*[[API Module Nameserver modifyZoneDnsRequest|modifyZoneDnsRequest]]
*[[API Module Nameserver modifyZoneDnsRequest|modifyZoneDnsRequest]]
Line 65: Line 77:
*[[API Module Nameserver modifyNsRequest|modifyNsRequest]]
*[[API Module Nameserver modifyNsRequest|modifyNsRequest]]
*[[API Module Nameserver deleteNsRequest|deleteNsRequest]]
*[[API Module Nameserver deleteNsRequest|deleteNsRequest]]
 +
*[[API Module Nameserver generateSingleDomainTokenRequest|generateSingleDomainTokenRequest]]
===SSL Module===
===SSL Module===
-
Working with the SSL products of Openprovider.
+
Methods to manage SSL certificates in your reseller account
*[[API Module SSL searchProductSslCertRequest|searchProductSslCertRequest]]
*[[API Module SSL searchProductSslCertRequest|searchProductSslCertRequest]]
*[[API Module SSL retrieveProductSslCertRequest|retrieveProductSslCertRequest]]
*[[API Module SSL retrieveProductSslCertRequest|retrieveProductSslCertRequest]]
Line 77: Line 90:
*[[API Module SSL cancelSslCertRequest|cancelSslCertRequest]]
*[[API Module SSL cancelSslCertRequest|cancelSslCertRequest]]
*[[API Module SSL retrieveApproverEmailListSslCertRequest|retrieveApproverEmailListSslCertRequest]]
*[[API Module SSL retrieveApproverEmailListSslCertRequest|retrieveApproverEmailListSslCertRequest]]
 +
*[[API Module SSL retrieveReissueApproverEmailListSslCertRequest|retrieveReissueApproverEmailListSslCertRequest]]
*[[API Module SSL resendApproverEmailSslCertRequest|resendApproverEmailSslCertRequest]]
*[[API Module SSL resendApproverEmailSslCertRequest|resendApproverEmailSslCertRequest]]
*[[API Module SSL changeApproverEmailAddressSslCertRequest|changeApproverEmailAddressSslCertRequest]]
*[[API Module SSL changeApproverEmailAddressSslCertRequest|changeApproverEmailAddressSslCertRequest]]
*[[API Module SSL decodeCsrSslCertRequest|decodeCsrSslCertRequest]]
*[[API Module SSL decodeCsrSslCertRequest|decodeCsrSslCertRequest]]
 +
*[[API Module SSL generateCsrSslCertRequest|generateCsrSslCertRequest]]
 +
*[[API Module SSL renewSslCertRequest|renewSslCertRequest]]
 +
*[[API Module SSL generateOtpTokenSslCertRequest|generateOtpTokenSslCertRequest]]
 +
* Getting real-time updates for the orders - [https://support.openprovider.eu/hc/en-us/articles/115015751808-Webhooks-for-SSL-events| Webhook system]
===License Module===
===License Module===
-
Working with the license products of Openprovider.
+
Methods to manage Plesk and Virtuozzo licenses in your reseller account
-
*[[API Module License searchProductLicenseRequest|searchProductLicenseRequest]]
+
*[[License Module API searchPleskLicenseRequest|searchPleskLicenseRequest]]
-
*[[API Module License retrieveProductLicenseRequest|retrieveProductLicenseRequest]]
+
*[[License Module API searchVirtuozzoLicenseRequest|searchVirtuozzoLicenseRequest]] (deprecated)
-
*[[API Module License searchLicenseRequest|searchLicenseRequest]]
+
*[[License Module API retrievePleskLicenseRequest| retrievePleskLicenseRequest]]
-
*[[API Module License retrieveLicenseRequest|retrieveLicenseRequest]]
+
*[[License Module API retrieveVirtuozzoLicenseRequest| retrieveVirtuozzoLicenseRequest]] (deprecated)
-
*[[API Module License retrieveKeyLicenseRequest|retrieveKeyLicenseRequest]]
+
*[[License Module API searchPleskAndVirtuozzoLicenseRequest|searchPleskAndVirtuozzoLicenseRequest]]
-
*[[API Module License createLicenseRequest|createLicenseRequest]]
+
*[[License Module API searchPleskAndVirtuozzoItemRequest|searchPleskAndVirtuozzoItemRequest]]
-
*[[API Module License editLicenseRequest|editLicenseRequest]]
+
*[[API Module License retrieveKeyPleskLicenseRequest| retrieveKeyPleskLicenseRequest]]
-
*[[API Module License upgradeLicenseRequest|upgradeLicenseRequest]]
+
*[[API Module License retrieveKeyVirtuozzoLicenseRequest| retrieveKeyVirtuozzoLicenseRequest]] (deprecated)
-
*[[API Module License deleteLicenseRequest|deleteLicenseRequest]]
+
*[[API License Module createPleskLicenseRequest| createPleskLicenseRequest]]
 +
*[[API License Module createVirtuozzoLicenseRequest| createVirtuozzoLicenseRequest]] (deprecated)
 +
*[[API License Module modifyPleskLicenseRequest|modifyPleskLicenseRequest]]
 +
*[[API Module License modifyVirtuozzoLicenseRequest|modifyVirtuozzoLicenseRequest]] (deprecated)
 +
<!--*[[API Module License upgradeLicenseRequest|upgradeLicenseRequest (deprecated)]]-->
 +
*[[License Module API resetLicenseHWID|resetLicenseHWID]]
 +
*[[API License Module deletePleskLicenseRequest|deletePleskLicenseRequest]]
 +
*[[API License Module deleteVirtuozzoLicenseRequest|deleteVirtuozzoLicenseRequest]] (deprecated)
-
===Tutorial Module===
+
<!--===Tutorial Module===
-
Working with the tutorial products of Openprovider.
+
Methods to manage tutorial products in your reseller account
*[[API Module Tutorial searchTutorialRequest|searchTutorialRequest]]
*[[API Module Tutorial searchTutorialRequest|searchTutorialRequest]]
*[[API Module Tutorial retrieveTutorialRequest|retrieveTutorialRequest]]
*[[API Module Tutorial retrieveTutorialRequest|retrieveTutorialRequest]]
-
*[[API Module Tutorial orderTutorialRequest|orderTutorialRequest]]
+
*[[API Module Tutorial orderTutorialRequest|orderTutorialRequest]]-->
===SpamExperts Module===
===SpamExperts Module===
-
Working with the SpamExperts products of Openprovider.
+
Methods to manage spam-filtering service on your domains via SpamExperts
*[[API Module SpamExperts createDomainSeRequest|createDomainSeRequest]]
*[[API Module SpamExperts createDomainSeRequest|createDomainSeRequest]]
*[[API Module SpamExperts modifyDomainSeRequest|modifyDomainSeRequest]]
*[[API Module SpamExperts modifyDomainSeRequest|modifyDomainSeRequest]]
 +
*[[API Module SpamExperts retrieveDomainSeRequest|retrieveDomainSeRequest]]
*[[API Module SpamExperts deleteDomainSeRequest|deleteDomainSeRequest]]
*[[API Module SpamExperts deleteDomainSeRequest|deleteDomainSeRequest]]
*[[API Module SpamExperts generateSeLoginUrlRequest|generateSeLoginUrlRequest]]
*[[API Module SpamExperts generateSeLoginUrlRequest|generateSeLoginUrlRequest]]
===Reseller Module===
===Reseller Module===
-
Managing your reseller account.
+
Methods to manage your reseller account
*[[API Module Reseller retrieveResellerRequest|retrieveResellerRequest]]
*[[API Module Reseller retrieveResellerRequest|retrieveResellerRequest]]
*[[API Module Reseller modifyResellerRequest|modifyResellerRequest]]
*[[API Module Reseller modifyResellerRequest|modifyResellerRequest]]
Line 120: Line 146:
===Financial Module===
===Financial Module===
-
Viewing your financial information.
+
Methods to get financial details from your account
*[[API Module Financial searchPaymentResellerRequest|searchPaymentResellerRequest]]
*[[API Module Financial searchPaymentResellerRequest|searchPaymentResellerRequest]]
*[[API Module Financial searchInvoiceResellerRequest|searchInvoiceResellerRequest]]
*[[API Module Financial searchInvoiceResellerRequest|searchInvoiceResellerRequest]]
*[[API Module Financial searchTransactionResellerRequest|searchTransactionResellerRequest]]
*[[API Module Financial searchTransactionResellerRequest|searchTransactionResellerRequest]]
 +
*[[API Module Financial searchPromotionBillingRequest|searchPromotionBillingRequest]]
===Email Module===
===Email Module===
-
Validating email adresses for ICANN verification
+
As ICANN accredited registrar we are obliged to validate email addresses for all domains in gTLD zones. These methods will help our resellers to manage the verification process.
*[[API Module Email startCustomerEmailVerificationRequest|startCustomerEmailVerificationRequest]]
*[[API Module Email startCustomerEmailVerificationRequest|startCustomerEmailVerificationRequest]]
*[[API Module Email restartCustomerEmailVerificationRequest|restartCustomerEmailVerificationRequest]]
*[[API Module Email restartCustomerEmailVerificationRequest|restartCustomerEmailVerificationRequest]]
*[[API Module Email searchEmailVerificationDomainRequest|searchEmailVerificationDomainRequest]]
*[[API Module Email searchEmailVerificationDomainRequest|searchEmailVerificationDomainRequest]]
 +
 +
===Email Templates Module===
 +
Used to customize email templates. ICANN emails are sent based on the templates that reseller builds in his account. If no custom templates are built by the reseller - ICANN e-mails are sent based on the default templates
 +
*[[API Module Email Templates searchEmailTemplateRequest|searchEmailTemplateRequest]]
 +
*[[API Module Email Templates createEmailTemplateRequest|createEmailTemplateRequest]]
 +
*[[API Module Email Templates modifyEmailTemplateRequest|modifyEmailTemplateRequest]]
 +
*[[API Module Email Templates deleteEmailTemplateRequest|deleteEmailTemplateRequest]]
 +
 +
===Tag Module===
 +
Could be used to manage ICANN emails recipient groups. Resellers can group customers via tags functionality. Once ICANN e-mail templates are customized per customer group - it is possible to setup sending ICANN e-mails to different customer groups with different layout, look and feel.
 +
*[[API Module Tag createTagRequest|createTagRequest]]
 +
*[[API Module Tag deleteTagRequest|deleteTagRequest]]
 +
*[[API Module Tag searchTagRequest|searchTagRequest]]
 +
 +
==API response codes==
 +
===API responses & error handling===
 +
Each API call responds with response code and description (if required).
 +
*[[API module Error handling|Error handling]]

Current revision as of 06:25, 13 May 2021

Contents

Welcome to the Openprovider documentation pages

On those pages, documentation can be found about integration of the Openprovider API in your own systems. Changes to the documentation will be tracked in the changelog.

How to use the API

Quickly get familiarized with the API of Openprovider.

API Commands

Authentication

Each API call requires authentication, either via password or password hash.

Customer Module

Methods to manage customers data in your reseller account. Every customer created in our system gets unique identifier or customer handle. Customer handles are used throughout the whole system in all product modules (domains, SSL, licenses etc).

Domain Module

Methods to manage domains in your reseller account

Extension Module

Methods to get more info around domain extensions (TLDs)

Nameserver Group Module

Managing your nameserver groups for easier domain management.

Nameserver module

Managing your DNS zones and DNS templates.

SSL Module

Methods to manage SSL certificates in your reseller account

License Module

Methods to manage Plesk and Virtuozzo licenses in your reseller account


SpamExperts Module

Methods to manage spam-filtering service on your domains via SpamExperts

Reseller Module

Methods to manage your reseller account

Financial Module

Methods to get financial details from your account

Email Module

As ICANN accredited registrar we are obliged to validate email addresses for all domains in gTLD zones. These methods will help our resellers to manage the verification process.

Email Templates Module

Used to customize email templates. ICANN emails are sent based on the templates that reseller builds in his account. If no custom templates are built by the reseller - ICANN e-mails are sent based on the default templates

Tag Module

Could be used to manage ICANN emails recipient groups. Resellers can group customers via tags functionality. Once ICANN e-mail templates are customized per customer group - it is possible to setup sending ICANN e-mails to different customer groups with different layout, look and feel.

API response codes

API responses & error handling

Each API call responds with response code and description (if required).

Retrieved from "https://doc.openprovider.eu/Main_Page"
Views
Personal tools