Sell domains in your app

​

Overview

​

1. Integration Guide

​

2. Sell Registrars

​

3. Frequently Asked Questions

​

Integration Guide

​

Step 1: Configure Entri

​

Step 2: Select your Sell registrar partner

​

Step 3: Define your return URLs (optional)

• successCallbackUrl: The URL to which the user will be redirected after a successful domain purchase.
• exitCallbackUrl: The URL to which the user will be redirected if they select Close (X) before completing the purchase flow.

​

Step 4: Call purchaseDomain()

<button type="button" onclick="entri.purchaseDomain(config)">Purchase Domain</button>

​

Configuration object specifications

​

Basic Configuration

• applicationId (string): A unique identifier for your application, available in the Entri dashboard. Example: "12345"
• token (string): A JWT token used for authentication and authorization. Example: "JWT_TOKEN"
• sellVersion (string) (only for IONOS): This only applies to customers using IONOS as their Sell Registrar. This specifies the version of the IONOS domain purchase flow that should be shown. Setting this to "v3" will activate the latest version with enhanced features. Example: "v3"
• successCallbackUrl (string) (optional): The URL to which the user will be redirected after a successful domain purchase. The purchased domain will be added as a domain query string parameter to the success callback URL. Example: "https://myapplication.com/success" (redirects to https://myapplication.com/success?domain=mydomain.com)
• exitCallbackUrl (string) (optional): The URL to which the user will be redirected if they select Close (X) before completing the purchase flow. Example: "https://myapplication.com/exit"

​

DNS Records

• dnsRecords (array of objects): An array containing DNS record objects. These records will applied after a successful domain purchase.
• Example:

[
  { "type": "A", "host": "@", "value": "93.184.216.34", "ttl": 300 },
  { "type": "A", "host": "aipv4", "value": "93.184.216.34", "ttl": 300 }
]

​

Webhook Notifications

​

Migrating from IONOS V2 => V3?

​

Step 1: Update the sellVersion

• Add the sellVersion Key: Ensure that your configuration includes the sellVersion key set to "v3". This will activate the new version of the domain purchase flow.

{
  "sellVersion": "v3"
}

​

Step 2: Implement New Redirect URLs

• Add successCallbackUrl and exitCallbackUrl: Define where users should be redirected after the domain purchase flow is completed, whether successfully or due to an error.

{
  "successCallbackUrl": "https://[your_success_callback_url].com",
  "exitCallbackUrl": "https://[your_exit_callback_url].com"
}

​

Step 3: Update Theming Options

• Expand Theme Configuration: Review and expand your theme settings to include new customizations like the onSecondary and secondary keys, which control the colors of interactive elements like buttons.

{
  "theme": {
    "primary": "#012939",
    "onPrimary": "#ffffff",
    "secondary": "#ffffff",
    "onSecondary": "#012939",
    "headerBackground": "#012939",
    "interactive": "#ffcc00",
    "premiumBadge": "#00ffcc",
    "onPremiumBadge": "#ffffff",
    "priceBadge": "ff6600",
    "onPriceBadge": "ffffff",
    "activating": "#ff4500",
    "onActivating": "#000000"
  }
}

​

Step 4: Customize the sell Object (Optional)

• Add Branding and User Data: If you want to leverage the new cobranded experience, populate the sell object with your partner branding and prefilled user data. This includes fields like partnerLogo, partnerIcon, partnerName, and the contact object.

{
  "sell": {
    "partnerLogo": "https://cdn.yourpartner.com/logo.svg",
    "partnerIcon": "https://cdn.yourpartner.com/icon.svg",
    "partnerName": "YourPartnerName",
    "contact": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "address": "123 Main St",
      "zip": "12345",
      "city": "Exampleville",
      "state": "EX",
      "postalCode": "12345",
      "country": "US"
    }
  }
}

​

Step 5: Test the New Configuration

• Conduct Thorough Testing: After updating your configuration, thoroughly test the domain purchase flow to ensure that all new features are working correctly and that the theming, branding, and user data are displayed as expected.

​

Step 6: Deploy the Updated Configuration

• Roll Out to Production: Once you are satisfied with the testing, deploy the updated configuration to your production environment. Monitor the transition to ensure a seamless experience for your users.

​

Sell Registrars

​

IONOS

• Highly customizable user experience
• FREE domain for first year offer (only for paid users)
• 300+ TLDs available
• Supports 7 languages and 52 countries
• Offer users an email inbox with their domain
• Customer support handled by IONOS

​

Whitelabeling/Branding

• theme (object): Customizes the colors used in the purchase flow.
  • primary (string): Main color used in your theme. It’s usually the most recognizable color in the interface. Example: "#012939"
  • onPrimary (string): Color used for text and icons that appear on top of the primary color. Example: "#ffffff"
  • secondary (string): Color that complements the primary color and is used for secondary UI elements. Example: "#012939"
  • onSecondary (string): Color used for text and icons that appear on top of the secondary color. Example: "#ffffff"
  • headerBackground (string) (optional): Background color of the header. Accepts any valid CSS color code (e.g., hex, rgb). If not defined, it will default to the primary color value. Example: "#123456"
  • interactive (string) (optional): Color for interactive elements such as radio buttons. Accepts any valid CSS color code (e.g., hex, rgb). Example: "#ffcc00"
  • premiumBadge (string) (optional): Background color of premium badge components. Accepts any valid CSS color code (e.g., hex, rgb). Example: "#00ffcc"
  • onPremiumBadge (string) (optional): Text color on the premium badge. Accepts any valid CSS color code (e.g., hex, rgb). Example: "#ffffff"
  • priceBadge (string) (optional):This field specifies the background color of the price badge component. Accepts any valid CSS color code (e.g., hex, rgb).Example: "#ff6600"
  • onPriceBadge (string) (optional):This field specifies the text color on the price badge. Accepts any valid CSS color code (e.g., hex, rgb).Example: "#ffffff"
  • activating (string) (optional): Background color of the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb). Example: "#ff4500"
  • onActivating (string) (optional): Text color on the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb). Example: "#000000"
• hideEntriLogo (boolean): Hide the Entri logo in the purchase flow. Example: true
• hideCompanyLogo (boolean): Hide the company logo in the purchase flow. Example: true
• hideCompanyName (boolean): Hide the company name in the purchase flow. Example: true
• customCopy (object): Custom text to be displayed in the purchase flow.
  • initialScreen.title.{locale} (object): Title text that appears on the initial screen of the domain purchase flow, localized by language. Example: "Search for your domain"
  • initialScreen.marketingCopy.{locale} (object): Marketing copy that appears below the domain input field, localized by language. Example: "Your website will look even better with a custom domain!"

​

Ionos Sell Object

• whiteLabel.sell (object): Contains information specific to the cobranding and user data prefill in the domain purchase flow.
  • flowTarget (string): The target location where the purchase flow window will be displayed. If _blank is specified, the flow will open in a new browser tab. Example: "_blank"
  • overlayScreenHeight (string): The percentage of the viewport height allocated to the search domain screen overlay. Example: "80%"
  • partnerLogo (string): The URL of the partner’s logo, which will be displayed prominently in the cobranded header. Example: "https://cdn.goentri.com/mylogo.svg"
  • partnerIcon (string): The URL of the partner’s icon, which will appear in the floating cart at the bottom of the page. Example: "https://cdn.goentri.com/myicon.svg"
  • partnerName (string): The name of the partner company, displayed within the purchase flow. Example: "My Company name"
  • contact (object): Prefilled user data to be used in the contact information form during domain creation. The following fields are supported:
    • firstName (string): User’s first name. Example: "John"
    • lastName (string): User’s last name. Example: "Doe"
    • email (string): User’s email address. Example: "john.doe@example.com"
    • phone (string): User’s phone number. Example: "+1234567890"
    • address (string): User’s street address. Example: "123 Main St"
    • zip (string): User’s ZIP or postal code. Example: "12345"
    • city (string): User’s city. Example: "Exampleville"
    • state (string): User’s state or province. Example: "EX"
    • postalCode (string): User’s postal code. Example: "12345"
    • country (string): User’s country. Example: "US"

​

Other Settings

• freeDomain (boolean): Indicates whether the domain price should be set to $0. Should only be used on paid users at the customer’s platform. Example: true
• locale (string): The language/locale to be used in the domain purchase flow. Example: "en"

​

Advanced Security Settings for freeDomain

fetch("https://api.goentri.com/token", {
  method: "POST",
  body: JSON.stringify({
    // These values come from the Entri dashboard
    applicationId: "12345",
    secret: "12345-67890",
    freeDomain: true,
  }),
})
  .then((response) => response.json())
  .then((data) => {
    console.log("Success:", data); // { "auth_token": "exampletoken..." }
    // Save the token in a variable or state manager for later use
  });

​

Mail Upsell

{
  "applicationId": "exampleapp",
  "token": "JWT_TOKEN",
  "sellVersion": "v3",
  "disableMailUpsell": true,
  "successCallbackUrl": "https://[your_success_callback_url].com",
  "exitCallbackUrl": "https://[your_exit_callback_url].com",
  "dnsRecords": [
    { "type": "A", "host": "@", "value": "93.184.216.34", "ttl": 300 }
  ],
  "whiteLabel": {
    "logo": "https://cdn.yourpartner.com/logo.svg",
    "theme": {
      "fg": "#ffffff",
      "bg": "#012939",
      "fgSecondary": "#ffffff",
      "bgSecondary": "#012939"
    }
  }
}

​

Squarespace

• 300+ TLDs to choose from.
• Award-winning support from Squarespace.
• Default domain privacy for added security.
• Instant DNS setup after purchase.
• Seamless connection to your website.
• Easy-to-use management dashboard.

​

Post purchase asynchronous DNS configurations

​

Squarespace Sell Object

• whiteLabel.sell (object): Contains information specific to the cobranding and user data prefill in the domain purchase flow.
  • contact (object): Prefilled user data to be used in the contact information form during domain creation. The following fields are supported:
    • firstName (string): User’s first name. Example: "John"
    • lastName (string): User’s last name. Example: "Doe"
    • email (string): User’s email address. Example: "john.doe@example.com"
    • phone (string): User’s phone number. Example: "+1234567890"
    • address (string): User’s street address. Example: "123 Main St"
    • zip (string): User’s ZIP or postal code. Example: "12345"
    • city (string): User’s city. Example: "Exampleville"
    • state (string): User’s state or province. Example: "EX"
    • postalCode (string): User’s postal code. Example: "12345"
    • country (string): User’s country. Example: "US"

​

Frequently Asked Questions

​

Who is the registrar for the domain?

​

How should I decide which registrar partner to use?

​

How is billing handled?

​

Who is responsible for customer support relating to the domain purchased?

​

Can I earn a commission for each domain purchased?