Openprovider

https://docs.openprovider.com/
Admin
Openprovider is a RESTful API platform that provides access to internet services including domain...
Tokens:321,392
Snippets:1,007
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create Customer Request Example

Source: https://docs.openprovider.com/swagger.json

Example of a JSON payload for creating a new customer. Ensure all required fields are populated correctly.

```json
{
"customer": {
"additional_data": [],
"address": {
"city": "City",
"country": "Country",
"street": "street",
"street_number": "1",
"postal_code": "12345"
},
"vat_number": "NL123456789X11",
"company_name": "Company Name",
"email": "test@mail.tld",
"fax": {
"area_code": "001",
"country_code": "+01",
"subscriber_number": "123456"
},
"handle": "XX123456-XX",
"id": 123456,
"is_private_enterpreneur": "",
"legal_form": "",
"locale": "nl_NL",
"name": {
"first_name": "Test",
"last_name": "Person",
"middle_name": "Nikolaevich"
},
"phone": {
"area_code": "10",
"country_code": "+01",
"subscriber_number": "123456"
},
"tags": [
{
"key": "customer",
"value": "VIP"
}
],
"vat": "12345678"
},
"name": "ru"
}

```

--------------------------------

### Create SSL Order Request Example

Source: https://docs.openprovider.com/swagger.json

This is an example of a request body for creating an SSL order. It includes details such as product ID, period, and technical handles.

```json
{
    "additional_data": [
        {
            "dns_record": "_acme-challenge.in.com",
            "method": "dns"
        }
    ],
    "organization_handle": "IA900531-NL",
    "period": 1,
    "product_id": 5,
    "signature_hash_algorithm": "sha2",
    "software_id": "linux",
    "start_provision": false,
    "technical_handle": "IA900531-NL"
}
```

--------------------------------

### Get DNS Zone Response Example

Source: https://docs.openprovider.com/doc/all

Example of a response when retrieving a specific DNS zone. It provides core zone information like ID, type, name, and dates.

```json
{
    "data":
    {
        "id": 9146574,
        "reseller_id": 204661,
        "type": "master",
        "name": "demo-domain.nl",
        "active": 1,
        "creation_date": "2019-06-27 06:22:36",
        "modification_date": "2019-06-27 06:22:36"
    }
}
```

--------------------------------

### CSR Creation Response Example

Source: https://docs.openprovider.com/

Example response from the CSR creation endpoint, containing the generated command and the private key.

```json
{
    "data":
    {
        "command": "openssl req -new -sha256-newkey rsa:2048 -nodes -config alt.names.cfg-out your.csr -keyout your.private.key-subj\"/C=NL/ST=Noord-Holland/L=Haalem/O=OpenproviderB.V./OU=IT/CN=ssl-123-domain.com/emailAddress=admin@ssl-123-domain.com\"",
        "key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDNUhGr0aSbrb42\nC1bfvYzfbnDCR0PCYIqXsplAe4yx4EPTVa37ureKxZUMPhfVbsZRpPG9zxWSlpy\nvMsF/mU47t4pCCCoG0pTkAk3wVHGsYwUFRj30PBBqrMAspkUkhjaF6NkbcykS8mE\nkIHdam7a7Rx3lFwinauF4VmDKVERm+MtoaSiUKVAHEddivaXV2YZAc5i3cuu2bgW\nkTFQfZ+JUJXAwzqFUd8Hf9GzbEK75q7t2xO6tNedaV7MaI2khcEs+7helaP8rWxE\nuEBA6UI+/QD/1HcN2yF+lQV0hzL1s1wIigFf/CIB9dLpVb4C80tlwcDbZK8o+sxO\naOv5if6JAgMBAAECggEBAJCTraXTZZnJ6hqcOXwrOTtLxVLIY8pHuM/BD3D8jsHi\nLWBvAKg1fnDVWHMD68EV2T2fGQgNqAsLKE2K61s5G4XPjdhOxNAbB2d4EUWVd0P2\nWbD6ei5mjgdvb8SZ/nkhtyY7Zu6c8nDufOQ/7XJAM/cs59K8QXSOme0YFbPqMA+4\n9n1jD6XvoXDJKKaJu2kBJJWo4YBUposUoe5oLN6BhwbFJpMlHfiGYIf8xfWZCYyE\nweRBBSi/vcQbpXxzve6jz4IT1Ag1TkjovrnGKZwZeaDGXjqWQEFAFcxpvHtZ9WXW\no+ffHrEi1BbDKlzpJMKDzxvvrwfU9gCgc7nue2gsghECgYEA6WTmTv+gJS2gfRtV\nsD/sYTqGm3x+ziScLP18P6c/BNNonkE87vcKDImKlomqQr16RV8HPKRKjT74cWkh\naxKZJWT6q92EmL1SSeRJjUXfVrVNc0uSmMwtgpHl4I0FojftGaz8AA9LqQBWj1zC\nbI+Jde9kmtssrJG5rS8/qnovV6sCgYEA4TUTCzTbBM6uJvfLJ2Tn+zkpWLQ7q8X0\n9LmnxplBPIO8Fzo6gwrlDQ8i7j3Bj5hzNgzvs8vl3zd9og3RwvyaAeMDKtZESa0n\nqB7yQ5Ova/rw3NlERWVhEodp+X7kMYcCt0KTI41Y0URqpXiKhZkWhokqQGMHUPSM\nKhegbZhtvpsCgYEA5MzUdodkgG3tUhgU9baEzYApa44tZXtAW16YinIzdlCl09aS\nnJUzlbzUTuVgMxM7JXyWRJ2utC8SMWPlrejKl30ZvJhpn66hV+zjKgpgesk7xxZD\n/WTUDJdoqqy05CU9W5lYZdqYynGZaet+chx4nlPz5VeNwRMO2jdii4ZCmQcCgYBt\naNqCpEAPWtWyqsmwrs4g98lFhfJDZl22EwgWbNgLrThQ1IIerclPid3/flMuDvNR\n/ADsCY/43L2VYD9bCltLtV0Rj50Hai8M91PdTr93pycjNA595F2/obfzdRkpkpzY\nKWjQadgPeryQ/TnW4+PUooi7VSD1zIjX3jibZeVTJwKBgEwHwKQo8XUP1PQ9ogPQ\nLZQElwlzKrCuzIgYgAhxtohF/7mpohPg15SWgf6cztgUVka/jBObZV0tLnNykWU3\n5wnF6rSUD4TECZLU0dA4o4Js8cXjnypFMAMfL6sxqCA1qVGLaZFiUcFYf8wA1IEP\ndJ9rB7SWCEtiM53WVQrPLdkD\n-----END PRIVATE KEY-----

```

--------------------------------

### Example cURL Request to Register Domain

Source: https://docs.openprovider.com/doc/all

This example demonstrates how to make a POST request to register a domain using cURL. It includes authorization, content type, and the request body with domain details.

```bash
curl -X POST \
https://api.openprovider.eu/v1beta/domains \
-H 'Authorization: Bearer <auth token>' \
-H 'Content-Type: application/json' \
-d ' {"admin_handle": "CV904717-NL", "billing_handle": "CV904717-NL", "owner_handle":"CV904717-NL", "tech_handle": "CV904717-NL", "domain":{"name": "greatdomain", "extension": "info"}, "period": "1", "name_servers":[{"name": "ns1.op.eu"}, {"name": "ns2.op.nl"},{"name": "ns3.op.be"}], "autorenew": "default"}'
```

--------------------------------

### Domain Check Response Example

Source: https://docs.openprovider.com/swagger.json

This example shows a typical response structure when checking domain availability, including response code, domain details, pricing information, and potential warnings.

```json
{
    "code": 0,
    "data": {
        "results": [
            {
                "claim_key": "",
                "domain": "example.com",
                "is_premium": false,
                "premium": {
                    "currency": "USD",
                    "price": {
                        "create": 0
                    }
                },
                "price": {
                    "product": {
                        "currency": "USD",
                        "price": 8.06
                    }
                }
            }
        ]
    },
    "desc": "OK",
    "maintenance": false
}
```

--------------------------------

### DNS Zone List Response Example

Source: https://docs.openprovider.com/doc/all

This is an example of a successful response when listing DNS zones. It includes details such as active status, creation date, and zone name.

```json
{
    "code": 0,
    "data":
    {
        "active": 1,
        "creation_date": "1328427448",
        "dnskey": "",
        "id": 1,
        "ip": "127.0.0.1",
        "is_deleted": false,
        "is_shadow": false,
        "is_spamexperts_enabled": false,
        "modification_date": "1543388225",
        "name": "domain.com",
        "reseller_id": 1,
        "type": "master"
    },
    "desc": ""
}
```

--------------------------------

### GET /websites/openprovider/ssl/products

Source: https://docs.openprovider.com/swagger.json

Retrieves a list of available SSL products and their details.

```APIDOC
## GET /websites/openprovider/ssl/products

### Description
Retrieves a list of available SSL products, including their specifications, pricing tiers, and reseller information.

### Method
GET

### Endpoint
/websites/openprovider/ssl/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip.

### Response
#### Success Response (200)
- **code** (integer) - API result code. 0 indicates success.
- **data** (object) - Contains the main response data.
  - **results** (array) - An array of SSL product objects.
    - **brand_name** (string) - The manufacturer brand of the SSL product.
    - **bypass_san** (boolean) - Indicates if SAN bypass is enabled (deprecated).
    - **category** (string) - The product category (e.g., DV, OV, EV).
    - **delivery_time** (string) - The estimated time for product delivery.
    - **description** (string) - A marketing description of the product.
    - **encryption** (string) - The encryption level of the root certificate.
    - **free_refund_period** (string) - The period during which a refund is possible.
    - **free_reissue_period** (string) - The period during which reissues are free.
    - **id** (integer) - The unique Openprovider Product ID.
    - **included_domains_count** (integer) - The number of domains included.
    - **is_extended_validation** (boolean) - Indicates if extended validation is required.
    - **is_idn** (boolean) - Indicates if IDN domains are supported.
    - **is_mobile_supported** (boolean) - Indicates if mobile devices are supported (deprecated).
    - **is_sgc_supported** (boolean) - Indicates if Server Gated Cryptography is supported (deprecated).
    - **is_wildcard** (boolean) - Indicates if the certificate is a wildcard certificate.
    - **level_prices** (array) - A list of prices for different levels.
      - **level** (integer) - The price level.
      - **name** (string) - The name associated with the price level.
    - **prices** (array) - An array of SSL product prices.
      - **extra_domain_price** (object) - The price for an additional domain.
        - **product** (object) - Details of the product for the extra domain price.
          - **currency** (string) - The currency of the price.
          - **price** (number) - The price amount.
        - **reseller** (object) - Reseller-specific pricing information.
          - **currency** (string) - The currency type for the reseller price.
  - **total** (integer) - The total number of available SSL products.

### Response Example
```json
{
    "code": 0,
    "data": {
        "results": [
            {
                "id": 123,
                "brand_name": "Comodo",
                "category": "DV",
                "delivery_time": "1-2 days",
                "description": "Basic Domain Validated SSL Certificate.",
                "encryption": "256 bits",
                "free_refund_period": "30 days",
                "free_reissue_period": "1 year",
                "included_domains_count": 1,
                "is_extended_validation": false,
                "is_idn": true,
                "is_mobile_supported": true,
                "is_sgc_supported": false,
                "is_wildcard": false,
                "level_prices": [
                    {
                        "level": 1,
                        "name": "Standard"
                    }
                ],
                "prices": [
                    {
                        "extra_domain_price": {
                            "product": {
                                "price": 10.00,
                                "currency": "USD"
                            },
                            "reseller": {
                                "currency": "USD"
                            }
                        }
                    }
                ],
                "bypass_san": false,
                "max_domains": 1,
                "order_module": "comodo"
            }
        ],
        "total": 30
    }
}
```
```

--------------------------------

### Domain Check Request Example

Source: https://docs.openprovider.com/swagger.json

This example demonstrates how to structure a request to check domain availability, including specifying the IDN script for internationalized domain names and the application mode for new gTLDs.

```json
{
    "additional_data": {
        "idn_script": "cyrl"
    },
    "application_mode": "preregistration",
    "domains": [
        {
            "extension": "london",
            "name": "test4"
        }
    ],
    "provider": "SEDO",
    "with_price": false
}
```

--------------------------------

### SSL Order OTP Token Response Example

Source: https://docs.openprovider.com/swagger.json

Example response for generating an OTP token. It contains a result code, data including the access URI, token, and expiration time, along with a description.

```json
{
 "code": 0,
 "data": {
 "uri": "http://sslinhva.openprovider.eu/auth-order-otp-token",
 "token": "RxFs3X_We6V12m0toZxmNuakfNm999BI",
 "expire_at": "2019-06-28 21:11:11"
 "desc": ""
}
}
```

--------------------------------

### Create Customer with Additional Data

Source: https://docs.openprovider.com/swagger.json

This example demonstrates how to create a customer by including the necessary additional data fields, such as 'country_of_citizenship' and 'whois_email', when registering a domain like .eu.

```bash
curl -X POST \
https://api.cte.openprovider.eu/v1beta/customers/ \
-H 'Authorization: Bearer 856481ca5a381e6f44785eb2bb352ae9' \
-d '{"address": {"street": "fake street", "number": "123", "city": "Hollywood", "zipcode": "90210", "state": "California", "country": "US"}, "company_name": "Hosters with Style", "email": "example@mail.tld", "fax": {"area_code": "303", "country_code": "+1", "subscriber_number": "123456"}, "name": {"first_name": "Carsten", "full_name": "Carsten G van Noort", "initials": "C.G.P.", "last_name": "van Noort", "prefix": "Dr."}, "phone": {"area_code": "111"'
```

--------------------------------

### EasyDmarc API Action Example

Source: https://docs.openprovider.com/swagger.json

Example of a recently triggered action status within the EasyDmarc API context.

```json
{
  "message": "",
  "recent_action": "enabled"
}
```

--------------------------------

### Creating a Customer with Additional Data

Source: https://docs.openprovider.com/

Example demonstrating how to create a customer and include specific additional data fields required for certain domain extensions, such as '.eu'.

```APIDOC
## POST /customers/

### Description
Create a customer and include specific additional data fields required for certain domain extensions.

### Method
POST

### Endpoint
https://api.cte.openprovider.eu/v1beta/customers/

### Request Body
- **address** (object) - Required - Customer address details.
  - **street** (string) - Required - Street name.
  - **number** (string) - Required - Street number.
  - **city** (string) - Required - City name.
  - **zipcode** (string) - Required - Zip code.
  - **state** (string) - Required - State or province.
  - **country** (string) - Required - Country code (e.g., US).
- **company_name** (string) - Optional - Company name.
- **email** (string) - Required - Customer email address.
- **fax** (object) - Optional - Fax number details.
  - **area_code** (string) - Required - Area code.
  - **country_code** (string) - Required - Country code (e.g., +1).
  - **subscriber_number** (string) - Required - Subscriber number.
- **name** (object) - Required - Customer name details.
  - **first_name** (string) - Required - First name.
  - **full_name** (string) - Optional - Full name.
  - **initials** (string) - Optional - Initials.
  - **last_name** (string) - Required - Last name.
  - **prefix** (string) - Optional - Name prefix.
- **phone** (object) - Required - Phone number details.
  - **area_code** (string) - Required - Area code.
  - **country_code** (string) - Required - Country code (e.g., +1).
  - **subscriber_number** (string) - Required - Subscriber number.
- **extension_additional_data** (array) - Optional - Array of additional data for specific extensions.
  - **data** (object) - Required - Key-value pairs of additional data.
    - **country_of_citizenship** (string) - Example: NL - Country of citizenship.
    - **whois_email** (string) - Example: company-mail@company-domain.tld - Email to be displayed in WHOIS.
  - **name** (string) - Required - The name of the extension (e.g., eu).

### Request Example
```json
{
  "address": {
    "street": "fake street",
    "number": "123",
    "city": "Hollywood",
    "zipcode": "90210",
    "state": "California",
    "country": "US"
  },
  "company_name": "Hosters with Style",
  "email": "example@mail.tld",
  "fax": {
    "area_code": "303",
    "country_code": "+1",
    "subscriber_number": "123456"
  },
  "name": {
    "first_name": "Carsten",
    "full_name": "Carsten G van Noort",
    "initials": "C.G.P.னமாக",
    "last_name": "van Noort",
    "prefix": "Dr."
  },
  "phone": {
    "area_code": "111",
    "country_code": "+1",
    "subscriber_number": "123456"
  },
  "extension_additional_data": [
    {
      "data": {
        "country_of_citizenship": "NL",
        "whois_email": "company-mail@company-domain.tld"
      },
      "name": "eu"
    }
  ]
}
```
```

--------------------------------

### Create a customer request example

Source: https://docs.openprovider.com/swagger.json

A cURL command to create a customer with the minimum required data.

```bash
curl -X POST https://api.openprovider.eu/v1beta/customers \
-H 'Authorization: Bearer <auth token>' \
-H 'Content-Type: application/json' \
-d '{"address": {"street": "Albusstraat", "number": "83", "city": "Oosterhout", "zipcode": "4903 RG", "state": "Noord-Brabant", "country": "NL"},"company_name": "Hosters with Style", "email": "example@mail.tld", "fax": {"area_code": "111", "country_code": "+05", "subscriber_number": "123456"}, "name": {"first_name": "Carsten", "full_name": "Carsten G van Noort", "initials": "C.G.P.", "last_name": "van Noort", "prefix": "Dr."}, "phone": {"area_code": "111", "country_code": "+04", "subscriber_number": "123456"}, "tags": [{"key": "customer", "value": "VIP"}]}'
```

--------------------------------

### Create Customer Request and Response

Source: https://docs.openprovider.com/doc/all

Example request for creating a customer and the corresponding JSON response containing the new handle.

```bash
curl -X POST https://api.openprovider.eu/v1beta/customers \
-H 'Authorization: Bearer <auth token>' \
-H 'Content-Type: application/json' \
-d '{"address": {"street": "Albusstraat", "number": "83", "city": "Oosterhout", "zipcode": "4903 RG", "state": "Noord-Brabant", "country": "NL"},"company_name": "Hosters with Style", "email": "example@mail.tld", "fax": {"area_code": "111", "country_code": "+05", "subscriber_number": "123456"}, "name": {"first_name": "Carsten", "full_name": "Carsten G van Noort", "initials": "C.G.P.", "last_name": "van Noort", "prefix": "Dr."}, "phone": {"area_code": "111", "country_code": "+04", "subscriber_number": "123456"}, "tags": [{"key": "customer", "value": "VIP"}]}'
```

```json
{
"code": 0,
"data": {
"handle": "CV904716-NL"
},
"desc": ""
}
```

--------------------------------

### Create a customer response example

Source: https://docs.openprovider.com/swagger.json

The JSON response returned after successfully creating a customer.

```json
{
"code": 0,
"data": {
"handle": "CV904716-NL"
},
"desc": ""
}
```

--------------------------------

### Customer Search Response Example

Source: https://docs.openprovider.com/swagger.json

Example JSON response when searching for customers. It includes a list of customer objects matching the search criteria.

```json
{
    "code": 0,
    "desc": "",
    "data":
    {
        "results":
        [
            {
                "id": 988275,
                "company_name": "Hosters with Style",
                "name":
                {
                    "initials": "C.G.P.",
                    "first_name": "Carsten",
                    "prefix": "Dr.",
                    "last_name": "van Noort",
                    "full_name": "Carsten Dr. van Noort"
                },
                "phone":
                {
                    "country_code": "+04",
                    "area_code": "111",
                    "subscriber_number": "123456"
                },
                "address":
                {
                    "street": "Albusstraat",
                    "street_number": "1",
                    "postal_code": "1234AB",
                    "city": "Amsterdam",
                    "country": "NL"
                }
            }
        ]
    }
}

```

--------------------------------

### SSL Products Response

Source: https://docs.openprovider.com/swagger.json

Example JSON response containing a list of SSL products and their associated metadata.

```bash
{
    "code": 0,
    "data":
    {
        "results":
        [
            {
                "id": 24,
                "name": "EV SSL",
                "brand_name": "Comodo",
                "category": "extended_validation",
                "is_mobile_supported": true,
                "is_idn_supported": false,
                "is_sgc_supported": false,
                "is_wildcard_supported": false,
                "is_extended_validation_supported": true,
                "delivery_time": "within 1 day",
                "free_refund_period": "30d",
                "free_reissue_period": "lifetime",
                "max_period": 2,
                "number_of_domains": 1,
                "encryption": "40/256 bits",
                "root": "Chained root",
                "validation_method": "extended",
                "warranty":
                {
                    "product":
                    {
                        "price": 250000,
                        "currency": "USD"
                    },
                    "reseller":
                    {
                        "price": 16286475,
                        "currency": "RUB"
                    }
                },
                "bypass_san": false,
                "included_domains_count": 1,
                "max_domains": 1,
                "order_module": "comodo"
            },
            {
                "id": 33,
                "name": "EVSSL multi-domain",
                "brand_name": "Comodo",
                "category": "multi_domain",
                "sub_category": "extended_validation",
                "is_mobile_supported": true,
                "is_idn_supported": false,
                "is_sgc_supported": false,
                "is_wildcard_supported": false,
                "is_extended_validation_supported": true,
                "delivery_time": "within 1 day",
                "free_refund_period": "30d",
                "free_reissue_period": "lifetime",
                "max_period": 2,
                "number_of_domains": 3,
                "encryption": "40/256 bits",
                "root": "Chained root",
                "validation_method": "extended",
                "warranty":
                {
                    "product":
                    {
                        "price": 250000,
                        "currency": "USD"
                    },
                    "resel
```

--------------------------------

### ReissueOrderRequest JSON Example

Source: https://docs.openprovider.com/swagger.json

Example payload for a certificate reissue request. Ensure the CSR is properly formatted and the approver email uses a standard administrative prefix.

```json
{
  "approver_email": "admin@example.com",
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwgYsxCzAJBgNVBAYTAkFVMREwDwYDVQQIDAhleGFtcGxlczER\nMA8GA1UEBwwIZXhhbXBsZXMxETAPBgNVBAoMCGV4YW1wbGVzMQswCQYDVQQLDAJp\ndDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFkbWluQGV4\nYW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6XbdNhvH\nRldtqE8iNm1Da0z+rkmAJlEtKUjqz5CDGcA9ByCLQ4qBIsSAkRgElBonMyR8lLDK\nh5Ac9jrkg40zrrXCl8TQ4sW5GFavwBPKCTHQu0EhovGWdV490+oOTVBckBW6niI5\nyaezhL4ZJzd4smrqoH3fPYPgLcb7+Lb4fsMfavRrallMrHP612bLm0mOpXKcwHos\nqBdC3OW2v64MnBdla3ZcPKFG8ThcdJoD9sym1EtKsm3MbyT9d8r3D+L2+xqZOjww\nacElCLmZ8Ep4aQVx0GRbJoDEA1Yy7A9YC4E+SObW7daquTX+zymeK0k1mACmOwvo\nJOrjLIhUbjJDtQIDAQABoAAwDQYJKoZIhvcNAQELBQADggEBANBGBu55iuzTYc4S\nZW3F8flSd0cO8ubKII6WcwHJrk8NIlAgfduAuNRuG9CAba0e72Ea0xKIhXSzxbDi\ncq9Yl0rkovY95ZyRayxl9AC4d7grJnncmKk2aUtarRq0pOaYfWuKwjaVPknGaGu6\nwCnGI/7nMCZA77ZH2s+rberHO+/6GCt+9pqSqY4u+2r83WMWMrVT/4jNBxKVErAk\n99iAC69+/N/afaryLoiAAtuaUPOAOD3fW4FXtjvvfht8xeU1AvYPOr0IfYdMH/Yq\n1EzRUsoxnhNG3Lb6YaQ0K59iFoBESSN5JHmLSLFEPb1i36Gx4kQMGJH8FM5tlPma\nySUlLeY=\n-----END CERTIFICATE REQUEST-----",
  "domain_validation_methods": [
    {
      "host_name": "example.com",
      "method": "https"
    }
  ],
  "enable_dns_automation": false,
  "host_names": [
    "www.example.com"
  ],
  "id": 1,
  "organization_handle": "TH000001-NL",
  "signature_hash_algorithm": "sha2",
  "software_id": "linux"
}
```

--------------------------------

### Create SSL Order Request

Source: https://docs.openprovider.com/doc/all

Use this endpoint to create a new SSL certificate order. Ensure all mandatory parameters like product_id, period, and software_id are provided. The `start_provision` parameter determines if the request is immediately sent to the CA.

```bash
curl -X POST \
 https://api.openprovider.eu/v1beta/ssl/orders \
 -H 'Authorization: Bearer <auth token>' \
 -H 'Content-Type: application/json' \
 -d '{
    "approver_email": "admin@ssl-123-domain.com",
    "autorenew": "off",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xs\nYW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYu\nMQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJ\nKoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3\nDQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAk\niJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCui\nMzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip0\n0ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFcl\nruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9e\nvTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkq\nhkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiC\nFnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8\nBDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq2\n1taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoI\nIa3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPo\namGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOd\nQ3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ\n4eJiaV7IwubPS78=
-----END CERTIFICATE REQUEST-----",
    "domain_amount": 1,
    "domain_validation_methods":
    [
        {
            "host_name": "ssl-123-domain.com",
            "method": "dns"
        }
    ],
    "organization_handle": "IA900531-NL",
    "period": 1,
    "product_id": 5,
    "signature_hash_algorithm": "sha2",
    "software_id": "linux",
    "start_provision": false,
    "technical_handle": "IA900531-NL"
}'
```

--------------------------------

### POST /v1beta/dns/nameservers

Source: https://docs.openprovider.com/swagger.json

Create a new nameserver.

```APIDOC
## POST /v1beta/dns/nameservers

### Description
Create a new nameserver entry.

### Method
POST

### Endpoint
/v1beta/dns/nameservers

### Parameters
#### Request Body
- **body** (object) - Required - The nameserver object to create.

### Response
#### Success Response (200)
- **nameserverCreateNameserverResponse** (object) - A successful response containing the created nameserver details.
```

--------------------------------

### Register Domain with Additional Data

Source: https://docs.openprovider.com/swagger.json

This example demonstrates how to register a .ca domain, including the required 'legal_type' additional data. Ensure you have the correct owner, billing, and tech handles, along with the domain name and extension.

```bash
curl -X POST / 
https://api.cte.openprovider.eu/v1beta/domains/ \
-d '{"owner_handle": "CV904717-NL", "billing_handle": "CV904717-NL", "tech_handle": "CV904717-NL", "domain": {"name": "canadian-trust-example", "extension": "ca"}, "ns_group": "testin", "period": "1", 
	
	"additional_data": 
		{
			"legal_type": "TRS"
		}
}' 
```

--------------------------------

### Register domain with additional data

Source: https://docs.openprovider.com/doc/all

Example of registering a domain while providing required additional data fields.

```bash
curl -X POST / 
https://api.cte.openprovider.eu/v1beta/domains/ \
-d '{"owner_handle": "CV904717-NL", "billing_handle": "CV904717-NL", "tech_handle": "CV904717-NL", "domain": {"name": "canadian-trust-example", "extension": "ca"}, "ns_group": "testin", "period": "1", 

    "additional_data": 
        {
            "legal_type": "TRS"
        }
}'
```

--------------------------------

### Domain Search Response Example

Source: https://docs.openprovider.com/doc/all

This is an example of a successful response when searching for domains. It includes details such as domain ID, status, owner information, and name servers. The 'id' field is crucial for subsequent domain operations.

```json
{
 'code': 0,
 'data': {
  'results': [
   {
    'active_date': '2021-09-27 07:06:00',
    'admin_handle': 'CV904717-NL',
    'auth_code': '!@#$%^&*()',
    'autorenew': 'off',
    'billing_handle': 'CV904717-NL',
    'can_renew': true,
    'comments': 'Any comments go',
    'comments_last_changed_at': '2021-09-27 07:05:59',
    'creation_date': '2021-09-27 07:03:04',
    'deleted_at': '0000-00-00 00:00:00',
    'dnssec': 'unsigned',
    'domain': {
     'extension': 'info',
     'name': 'greatdomain1'
    },
    'expiration_date': '2022-09-27 07:03:04',
    'has_history': true,
    'id': 1222095,
    'internal_auth_code': '0',
    'is_abusive': false,
    'is_deleted': false,
    'is_dnssec_enabled': true,
    'is_hosted_whois': true,
    'is_lockable': true,
    'is_locked': true,
    'is_premium': false,
    'is_private_whois_allowed': true,
    'is_private_whois_enabled': false,
    'last_changed': '2021-09-27 07:40:47',
    'modify_owner_allowed': true,
    'name_servers': [
     {
      'ip': '',
      'ip6': '',
      'name': 'ns1.testin.nl',
      'seq_nr': 0
     },
     {
      'ip': '64.190.62.111',
      'ip6': '',
      'name': 'ns2.testin.eu',
      'seq_nr': 1
     }
    ],
    'ns_group': 'testin',
    'ns_template_id': 0,
    'ns_template_name': '',
    'nsgroup_id': 161184,
    'order_date': '2021-09-27 07:05:59',
    'owner': {
     'company_name': 'Hosters with Style',
     'full_name': 'Carsten Dr. van Noort'
    },
    'owner_company_name': 'Hosters with Style',
    'owner_handle': 'CV904717-NL',
    'registry_expiration_date': '2022-09-27 07:03:04',
    'renew': 0,
    'renewal_date': '2022-09-27 07:03:04',
    'reseller_handle': '',
    'reseller_id': 242219,
    'status': 'ACT',
    'tech_handle': 'CV904717-NL',
    'trade_allowed': false,
    'trade_auth_code_required': 'no',
    'transfer_auth_code_required': 'yes',
    'transfer_cancel_supported': false,
    'type': 'NEW',
    'unit': 'y',
    'use_domicile': false
   },
   {
    'second example looks the same'
   }
  ],
  'total': 2
 },
 'desc': ''
}
```

--------------------------------

### POST /v1beta/dns/nameservers

Source: https://docs.openprovider.com/doc/all

Creates a new nameserver.

```APIDOC
## POST /v1beta/dns/nameservers

### Description
Creates a new nameserver record.

### Method
POST

### Endpoint
/v1beta/dns/nameservers

### Parameters
#### Request Body
- **ip** (string) - Optional - Nameserver IP
- **ip6** (string) - Optional - Nameserver IPv6
- **name** (string) - Optional - Nameserver name

### Request Example
{
  "ip": "127.0.0.1",
  "ip6": "0001:0001:0001:0001:0001:0001:0001:0001",
  "name": "ns1.domain.com"
}

### Response
#### Success Response (200)
- **code** (integer) - Status code
- **data** (object) - Nameserver details
- **desc** (string) - Description

#### Response Example
{
  "code": 0,
  "data": {
    "ip": "127.0.0.1",
    "ip6": "0001:0001:0001:0001:0001:0001:0001:0001",
    "name": "ns1.domain.com"
  },
  "desc": ""
}
```

--------------------------------

### GET /v1beta/licenses/virtuozzo

Source: https://docs.openprovider.com/

Lists all Virtuozzo licenses.

```APIDOC
## GET /v1beta/licenses/virtuozzo

### Description
Retrieves a list of Virtuozzo licenses with optional filtering.

### Method
GET

### Endpoint
/v1beta/licenses/virtuozzo

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Output limit
- **offset** (integer) - Optional - Output offset
- **key_id** (integer) - Optional - License key ID
- **key_number** (string) - Optional - License key number
- **title_pattern** (string) - Optional - Custom title pattern
- **key_number_pattern** (string) - Optional - License key number pattern
- **parent_key_id** (integer) - Optional - Key ID of the parent license

### Response
#### Success Response (200)
- **code** (integer) - Response code
- **data** (object) - Contains results array and total count
- **desc** (string) - Response description

#### Response Example
{
  "code": 0,
  "data": { "results": [], "total": 0 },
  "desc": "string"
}
```

--------------------------------

### GET /v1beta/dns/templates

Source: https://docs.openprovider.com/doc/all

Lists DNS templates.

```APIDOC
## GET /v1beta/dns/templates

### Description
Retrieves a list of DNS templates based on provided filters.

### Method
GET

### Endpoint
/v1beta/dns/templates

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Limits the number of objects in the output.
- **offset** (string) - Optional - Used to retrieve objects from a certain offset.
- **order** (string) - Optional - Sorting type (asc/desc).
- **order_by** (string) - Optional - Field for sorting output.
- **with_records** (boolean) - Optional - Indicates if DNS records should be retrieved.
- **name_pattern** (string) - Optional - Template name pattern.
```

--------------------------------

### GET /products/ssl

Source: https://docs.openprovider.com/swagger.json

Retrieves a list of available SSL products with their associated pricing and configuration details.

```APIDOC
## GET /products/ssl

### Description
Retrieves a list of available SSL products, including brand information, encryption levels, and pricing structures.

### Method
GET

### Endpoint
/products/ssl

### Response
#### Success Response (200)
- **results** (array) - List of SSL products
- **total** (integer) - Total count of results

#### Response Example
{
  "results": [
    {
      "brand_name": "Comodo",
      "category": "domain_validation",
      "description": "An EssentialSSL certificate from Comodo...",
      "id": 123456789,
      "name": "EssentialSSL",
      "prices": [
        {
          "period": 1,
          "price": {
            "product": { "currency": "USD", "price": 0 },
            "reseller": { "currency": "EUR", "price": 0 }
          }
        }
      ]
    }
  ],
  "total": 999
}
```
Tokens:
Raw