🌀API Portal Overview

Step-by-step process for deploying your self-hosted API Developer Portal for your customers and partners.

Features Included

Every API team needs a great Developer Portal, they just do not need to spend time building and maintaining it. With Astral Dx, you can be live in under 30 minutes with the following features out-of-the box:

  • Pre-built UIs for a clean UX and styled for your brand look-and-feel

  • Administration tools for inviting customer and partner development teams

  • Security tools for full customer access controls (e.g. instantly revoking API key access)

  • Pre-made plugins for fast API management configuration (Auth0, Kong, Tyk.io, etc.)

  • No-code real-time Developer Portal updates for branding and centralizing all elements of the Dx experience (API docs, Slack communities, etc.)

Administrator Preview

End User Preview

Flight Tools: Deploying your self-hosting your Astral API Portal is quick when you have these items ready open to go: local development environment with Git for source version control, Node.js and npm to install and run the Deploy CLI locally, and any API credentials for current and future Astral Plugins (e.g. Auth0, Tyk.io, etc.)

Step-by-Step Process

  1. Create your company account at www.astral.sh.

  2. Configure your API Portal branding, name, and docs references in the web editor for a preview

  3. Select your API authentication framework, and receive a template repository based on with four npm packages for simple deployment.

For a detailed guide on deployment, choose the option based on your API authentication framework:

🛠️pageDeploying with Custom Plugins🔐pageDeploying with Auth0

Updates: Once your API Portal is deployed, the Astral Dx team will provide package updates with new features and enhancements. Package updates will be communicated via email and the Discord server.

Resources

🚁pageSupport
NextDeploying with Auth0

Last updated