Quickstart

This guide will get you all set up and ready to use the SaaS Custom Domains API. We'll cover how to get started and make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Base URL

The base URL for all the API requests is https://app.saascustomdomains.com. All the API endpoints, e.g. /api/v1/me, are relative to the base URL. In the example of /api/v1/me, the full URL where you send your HTTP request would be https://app.saascustomdomains.com/api/v1/me.

Making your first API request

Once you have your API token, you are ready to make your first call to the SaaS Custom Domains API. Below, you can see how to send a GET request to the /me endpoint data about the user to whom the API token belongs. This is just a simple example, but you can use the same approach to make any API request.

curl https://app.saascustomdomains.com/api/v1/me \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"

{
    "id": 1,
    "name": "Rocky Balboa",
    "avatar_url": "https://secure.gravatar.com/avatar/xxxxxxx.png?default=mp&rating=pg&size=48"
}

What's next?

Great, you're now set up with an API token and have made your first request to the API. Here are a few links that might be handy as you venture further into SaaS Custom Domains API:

• Check out the Upstreams endpoint
• Learn about the different error messages in SaaS Custom Domains API