Main Page
From Openprovider API documentation
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. A list of release notes (releases, new features, bugfixes) can be found in the release notes.
How to use the API
Quickly get familiarized with the API of Openprovider.
API Commands
Authentication
Customer Module
Managing your own customers for use as domain or other contacts.
- searchCustomerRequest
- retrieveCustomerRequest
- createCustomerRequest
- modifyCustomerRequest
- deleteCustomerRequest
Domain Module
Requesting domain statuses and managing your existing and new domains.
- searchDomainRequest
- retrieveDomainRequest
- checkDomainRequest
- createDomainRequest
- transferDomainRequest
- tradeDomainRequest
- modifyDomainRequest
- renewDomainRequest
- deleteDomainRequest
- restoreDomainRequest
- tryAgainDomainRequest
- retrievePriceDomainRequest
- approveTransferDomainRequest
- requestAuthCodeDomainRequest
- resetAuthCodeDomainRequest
Extension Module
Finding information about the domain extensions in Openprovider.
Nameserver Group Module
Managing your nameserver groups for easier domain management.
- searchNsGroupRequest
- retrieveNsGroupRequest
- createNsGroupRequest
- modifyNsGroupRequest
- deleteNsGroupRequest
Nameserver module
Managing your DNS zones and DNS templates.
- searchTemplateDnsRequest
- retrieveTemplateDnsRequest
- createTemplateDnsRequest
- deleteTemplateDnsRequest
- searchZoneDnsRequest
- retrieveZoneDnsRequest
- createZoneDnsRequest
- modifyZoneDnsRequest
- deleteZoneDnsRequest
- searchNsRequest
- retrieveNsRequest
- createNsRequest
- modifyNsRequest
- deleteNsRequest
SSL Module
Working with the SSL products of Openprovider.
- searchProductSslCertRequest
- retrieveProductSslCertRequest
- searchOrderSslCertRequest
- retrieveOrderSslCertRequest
- createSslCertRequest
- reissueSslCertRequest
- modifySslCertRequest
- cancelSslCertRequest
- retrieveApproverEmailListSslCertRequest
- resendApproverEmailSslCertRequest
- changeApproverEmailAddressSslCertRequest
- decodeCsrSslCertRequest
- renewSslCertRequest
License Module
Working with the license products of Openprovider.
- searchProductLicenseRequest
- retrieveProductLicenseRequest
- searchLicenseRequest
- retrieveLicenseRequest
- retrieveKeyLicenseRequest
- createLicenseRequest
- editLicenseRequest
- upgradeLicenseRequest
- deleteLicenseRequest
Tutorial Module
Working with the tutorial products of Openprovider.
SpamExperts Module
Methods to manage spam-filtering service on your domains via SpamExperts
Reseller Module
Methods to manage your reseller account
- retrieveResellerRequest
- modifyResellerRequest
- retrieveSettingsResellerRequest
- retrieveStatisticsResellerRequest
- searchContactRequest
- retrieveContactRequest
- createContactRequest
- modifyContactRequest
- deleteContactRequest
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.
- startCustomerEmailVerificationRequest
- restartCustomerEmailVerificationRequest
- 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
- searchEmailTemplateRequest
- createEmailTemplateRequest
- modifyEmailTemplateRequest
- 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.