Skip to content

API Settings

You can always change the configuration of your API on the Settings page.

General settings

Name

The name of your API. This name your customers will see on the checkout page.

Base URL

The base URL for all API endpoints.

The full URL to which Project X API Gateway will forward users' requests is formed as Base URL + Endpoint URL.

Example

If your API has the following endpoints:

https://api.mydomain.com/weather-forecast/
https://api.mydomain.com/current-weather/
then https://api.mydomain.com/ is the base URL.

Short description

Short description is shown to your customers in case the full description is not filled in.

Full description

Full description is shown to your customers on the checkout pages and in the self-service portal.

Please provide a link to your Terms of Service/Terms and Conditions if you want it to be displayed to customers.

Please specify here a link to your API documentation if you want it to be displayed to customers.

Project X Gateway settings

Project X Gateway API subdomain

By default, Project X let's you choose a subdomain for your API, and the URL to access it looks like

https://<subdomain>.c1-eu-nmbg-hz.projectx.biz/

Later, you can configure Project X API Gateway to use a custom domain for your API, e.g. https://api.mydomain.com. Learn more.

Authentication instructions for API users

This is a textual description of how your API users should authenticate when making API calls. The text will be shown to your customers on the checkout and subscription pages.

By default, Project X Gateway expects the access token to be sent in the X-Billing-Token header.

This behavior can be changed: you can flexibly configure Project X Gateway to look for the access token in any other header (including the standard Authorization: Bearer scheme) or in an arbitrary field in JSON request body.

If you decide to configure user authentication differently, make sure to update the Authentication instructions for API users field.

See the Authentication chapter of this documentation to learn more.

Custom domain name

Project X allows attaching custom domain names to your API, so that instead of the default https://<subdomain>.c1-eu-nmbg-hz.projectx.biz/ URL, customers use your own domain name to make API calls.

Read more about that in the Custom domain name section of this documentation.