Custom Domain (API)

:::highlight yellow 💡
Having issues understanding the documentation? Watch our tutorial
:::

Overview

Some internet service providers (ISP) block requests to our API. One way to get around this is to use a vpn, of course this may not be the ideal for a lot of users, this is where custom domains come into place. A custom domain will allow you to point your own URL to our API and make requests that way.

Getting Started

Head over to your [application settings](https://keyauth.cc/app/?page=app-settings) Click on the "Add Custom domain" button Enter your custom domain. Do not include "https://" in your domain. Click on the Add Domain button. Click on the Setup Automatically button.

  <TipInfo>Cloudflare will then open up. Make sure you're signed into the account that has your domain. Then click the "authorize" button.</TipInfo>

After the Cloudflare popup closes, click on the "Check Domain" button. This process can take up to 1 minute!To prevent caching issues, do not visit your domain during this setup. After the 1 minute has passed, click on the "Check Domain" button again and you should get a success response. If not, press the button again, it may take a few more seconds depending on location, speed, domain, etc.

Test It Out

Open up command prompt on your device and type in,

curl https://yourwebsite.ext/1.0/ -H "user-agent:"

or if you put "api" in the root name, it would be

curl https://yourwebsite.ext/api/1.0/ -H "user-agent:"

If you set it up correctly, you should see:

{"success":false, "message":"Unhandled Type"}

Changing The Url In Your Application

Lastly, head over to our API class in your application, and search for "https://keyauth.win/api/1.2/", you will want to replace this with your new URL.

Last modified: 3 months ago