Here you can learn how to host and configure an additional Developer Portal.

Each Developer Portal can be customized individually. This is especially interesting if you want to bring different API products closer to different customers.

Create your new Developer Portal in the Admin Portal

Go to Configuration > Developer Portals > Create New Developer Portal in your Admin Portal.

• 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.

docker pull apiida/controlplane-devportal

Host and Configure your Developer Portal

Here is a docker-compose.yml script

  obsidian-devportal:
    image: xxx
    container_name: joshn-doe-api-shop
    ports:
      - "443:443"
    environment:
      - 'BACKEND_URL=https://yourSubdomain.backend.apiida.io/'
      - 'BACKEND_WS=wss://yourSubdomain.backend.apiida.io/'
      - 'DEV_PORTAL_TOKEN=yourToken'
  # 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/frontend.crt
  #   - ./frontend.key:/etc/ssl/private/frontend.key
  #   http://nginx.org/en/docs/
  #   - ./nginx.conf:/etc/nginx/conf.d/default.conf

A few more environment variables

That's it. Go to your new Developer Portal.

https://yourSubdomain.localhost

Customizing

Don't forget to customize your Developer Portal!

Content Management System (CMS)

Just a few impressions