...
Name
The name of the Developer Portal is displayed in the login screen.
Organization
When an organization is selected, only API products that this organization is allowed to see will appear there.
URL
We need the URL to avoid CORS problems. It must start with your subdomain and then a ".".
After creating, you will be shown a token. Copy it. We need it in a moment.
Get the Developer Portal Image
We provide you with a Docker image and also recommend docker to host it.
| Code Block |
|---|
docker pull apiida/controlplane-devportal |
Host and Configure your Developer Portal
Here is a docker-compose.yml script
| Code Block | ||
|---|---|---|
| ||
obsidian-devportal:
image: apiida/controlplane-devportal
container_name: joshn-doe-api-shop
ports:
- "3009:443"
environment:
BACKEND_URL: https://<tenant>.backend.apiida.io
# To disable the insertion of the tenant ID the string must not contain 'addTenantIdToBack'.
# INSERT_TENANT_ID: doNotInsertIt
DEV_PORTAL_TOKEN: vpfw2d823h8uQRN
TINY_EDITOR_API_KEY: YourEditorKey
# ssl configuration - here you can mount your certificate in the container and if you want, also change the whole nginx configuration.
# volumes:
# - ./frontend.crt:/etc/ssl/certs/devportal.crt
# - ./frontend.key:/etc/ssl/private/devportal.key
# http://nginx.org/en/docs/
# - ./nginx.conf:/etc/nginx/conf.d/default.conf |
A few more environment variables
Variable | Default Value | Description |
|---|---|---|
| The public URL of your Control Plane backend. This must be accessible from your webbrowser. For example: https://<tenant>.backend.apiida.io | |
| The link to the support portal. Is displayed as a button in the main menu and on the 'Not Found' page. | |
| 0qPG7xXzm65SnioUM2fK | The token of the Developer Portal. You can find this in the Administrations Portal. |
| addTenantIdToBackendUrl | To disable the insertion of the tenant ID the string must not contain 'addTenantIdToBack'. |
| 443 | Nginx Port with SSL. |
| 80 | Nginx Port with out SSL. |
| You must create and provide your own tiny api key here. This is free of charge! https://www.tiny.cloud/blog/how-to-get-tinymce-cloud-up-in-less-than-5-minutes/ |
...