API Reference

{
  ...,
  dnsRecords: [
    {
      type: "CNAME",
      host: "shop",
      value: "myapp.com",
      ttl: 300,
    },
    {
      type: "TXT",
      host: "@",
      value: "123-example-txt-record",
      ttl: 300,
    }
  ]
}

{
  ...,
  dnsRecords: {
    domain: [
      {
        type: "A",
        host: "@",
        value: "1.2.3.4",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ],
    subDomain: [
      {
        type: "CNAME",
        host: "shop",
        value: "myapp.com",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ]
}

{
  //...
  prefilledDomain: ["firstDomain.com", "secondDomain.com"],
  dnsRecords: {
    "firstDomain.com": [
      {
        type: "A",
        host: "@",
        value: "1.2.3.4",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ],
    "secondDomain.com": [
      {
        type: "CNAME",
        host: "shop",
        value: "myapp.com",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ]
}

{
  "whiteLabel": {
    "hideEntriLogo": true,
    "hideConfetti": true,
    "logo": "LOGO_URL",
    "theme": {
      "fg": "#fff",
      "bg": "#fa7268"
    },
    "logoBackgroundColor": "#444444",
    "removeLogoBorder": true,
    "customCopy": {
      "initialScreen": {
        "title": {
          "en": "Custom title",
          "es": "Título custom"
        },
        "subtitle": {
          "en": "Custom subtitle",
          "es": "Subtítulo custom"
        }
      },
      "manuallyScreen": {
        "disableManualSetupDocumentationLink": true,
        "stepByStepGuide": {
          "en": "Follow our <link>step-by-step</link> guide",
          "es": "Sigue nuestra guía <link>paso-a-paso</link>"
        }
      }
    }
  }
}

{
  applicationId: "12345",
  token: mySavedToken,
  secureRootDomain: true,
  wwwRedirect:true,
  dnsRecords: [...]
}

{
  applicationId: "12345",
  token: mySavedToken,
  secureRootDomain: true,
  wwwRedirect:true,
  dnsRecords: [
    {
      type: "A",
      host: "@",
      value: "{ENTRI_SERVERS}",
      ttl: 300,
      ssl: true,
      applicationUrl: "my.applicationurl.com" // [Optional] overrides the pre-configured applicationUrl
    },
    ... //Other records
  ]
}

const domainCheck = await entri.checkDomain("mydomain.com", config)

 {
  "provider": "Cloudflare", //Provider name or `Unknown`
  "setupType": "Automatic", // `Automatic` or `Manual`
  "NSSupport": {
    "root": true, //NS modifications support for the root domain for this provider
    "subdomains": true //NS modifications support for subdomains for this provider
  },
  "wwwRedirect": false,
  "cnameFlattening": false, 
  "wildcardSupport": true
}

POST https://api.goentri.com/checkdomain
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "domain": "ifpiggiescouldfly.com",
  "dnsRecords": [
      {
        "host": "shop",
        "type": "CNAME",
        "value": "exampledestination.com",
        "ttl": "300"
      }
    ]
}

POST https://api.goentri.com/connect/async
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]

{
  "applicationId": "clickfunnels",
  "domain": "domain.com",
  "subdomain": "www",
  "wwwRedirect": false,
  "dnsRecords": [
    {
      "value": "13.248.155.104",
      "host": "@",
      "ttl": 300,
      "type": "A"
    }
  ]
}

function handleOnEntriClose(event) {
  console.log('onEntriClose', event.detail);
}
window.addEventListener('onEntriClose', handleOnEntriClose, false);

{
  domain: "example.com",
  success: true,
  setupType: "automatic",
  provider: "Provider name",
  lastStatus: "IN_PROGRESS",
  freeDomain: true, // Only applies to Entri Sell free domain flows
  error: { // Added to the event details if the user closed the app after an error screen. 
    code: "ProviderError", 
    title: "Social Login Not Supported",
    details: "You are trying to login with Social Account, please try logging in from [PROVIDER_NAME] Account"
  }
}

function myCustomFunction(event) {
  //Custom code here e.g. open chat app
}
window.addEventListener('onEntriManualSetupDocumentationClick', myCustomFunction, false);

function myCustomFunction(event) {
	console.log('onEntriStepChange', event.detail);
}
window.addEventListener('onEntriStepChange', myCustomFunction, false);

{
  domain: "example.com",
  provider: "Provider name",
  step: "ENTER_DOMAIN",
  user: "user-123456"
}

{
  "id": "028b5078-8fed-4ffb-8e3e-3e6e6d8214b4",
  "user_id": "sample-user",
  "domain": "smallbusiness.com",
  "type": "domain.added",
  "propagation_status": "success",
  "dkim_status": "success",
  "redirection_status": "exempt",
  "ssl_status": "success",
  "setup_type": "automatic",
  "secure_status": "success", //Only for Entri Secure usage
  "power_status" : "success", //Only for Entri Power usage
  "cname_target": "my.saascompany.com", //Only for Entri Power and Secure usage
  "purchased_domains": ["domain1.com",...,"domainN.com"], //Only for Entri Sell usage
  "data": {
    "records_propagated": [
      {
        "type": "A",
        "host": "smallbusiness.com",
        "value": "54.153.2.220"
      },
      {
        "type": "CNAME",
        "host": "www",
        "value": "smallbusiness.com"
      }
    ],
    "records_non_propagated": [],
    "updated_objects": [
      "propagation_status",
      "ssl_status"
    ]
  }
}

GET https://api.goentri.com/ssl?domain=www.example.com&rootDomain=false
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  // Is the domain CNAMEed to the cname_target of the application?
  "eligible": true | false,

  // Is SSL provisioned?
  "sslStatus": "active" | "inactive",

  // Current cnameTarget set on the Dashboard
  "cnameTarget": URL | "",

  // Current cnameTarget value for the domain
  "applicationUrl": URL | ""
}

POST https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "domain": "www.example.com",
  "applicationUrl": "my.applicationurl.com", /*Optional*/
  "redirectTo": "shops.example.com" /*Optional*/
}

{ "message": "Success." }

PUT https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{ "domain": "www.example.com" }

{ "message": "Success." }

DELETE https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{ "domain": "www.example.com" }

{ "message": "Success." }

GET https://api.goentri.com/power?domain=www.example.com&rootDomain=false
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  // Is the domain CNAMEed to the cname_target of the application?
  "eligible": true | false,

  // Is the domain already powered?
  "powerStatus": "active" | "inactive",

  // Current cnameTarget set on the Dashboard
  "cnameTarget": URL | "",

  // Current cnameTarget value for the domain
  "applicationUrl": URL | "",

  //Paths with granted access to the root of the Application URL
  "powerRootPathAccess": [] | ["/path1", "/path2",..., "pathN"]
}

POST https://api.goentri.com/power
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "domain": "www.example.com",
  "applicationUrl": "my.applicationurl.com",
  /*Optional*/ "powerRootPathAccess: ['/path1', '/path2',..., '/pathN']
}

{ "message": "Success." }

PUT https://api.goentri.com/power
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "domain": "www.example.com",
  "applicationUrl": "my.applicationurl.com",
  /*Optional*/ "powerRootPathAccess: ['/path1', '/path2',..., '/pathN']
}

{ "message": "Success." }

{ "domain": "www.example.com" }

{ "message": "Success." }

POST https://api.goentri.com/sharing/connect
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "applicationId": "yourApplicationID",
  "domain": "www.example.com",
  "dnsRecords": {
    "type": "cname",
    "host": "@",
    "value": "www",
    "ttl": 1800
  },
  //All the rest of possible configuration options, see https://developers.entri.com/api-reference#entrishowentriconfig for more details.
}

{
    "link": "https://app.goentri.com/share/dd339cf05f2646539e79251f8e62f0c5",
    "job_id": "9c128fe4-63cd-4ec4-9ae8-8a9d06c0e6de"
}

POST https://api.goentri.com/sharing/sell
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

{
  "applicationId": "yourApplicationID",
  "domain": "www.example.com",
  "dnsRecords": {
    "type": "cname",
    "host": "@",
    "value": "www",
    "ttl": 1800
  },
  //All the rest of possible configuration options, see https://developers.entri.com/api-reference#entrishowentriconfig for more details.
}