This is the Astral DX API developer portal.

Product and Partnership teams use the Astral DX API portal get a Stripe-like API portal, without the months of engineering expense.

Features

• Branded Developer API Portal
• Automated API Credential Management (Sandbox and Production Enviroments)
• Administrative Security
• Supports Developer Teams & Invitations

Getting Started

First, create an .env.local at the root of the project and provide any necessary environment variables.

# .env.local

# For Auth0 Authencation
AUTH0_SECRET=
AUTH0_BASE_URL=http://localhost:3000
AUTH0_ISSUER_BASE_URL=
AUTH0_CLIENT_ID=
AUTH0_CLIENT_SECRET=

# For Auth0 Team Management
AUTH0_ADMIN_INVITE_SIGNING_SECRET=
AUTH0_TEAM_INVITE_SIGNING_SECRET=

# For Auth0 API Credentials
PRODUCTION_AUTH0_MANAGEMENT_CLIENT_DOMAIN=
PRODUCTION_AUTH0_MANAGEMENT_CLIENT_ID=
PRODUCTION_AUTH0_MANAGEMENT_CLIENT_SECRET=
SANDBOX_AUTH0_MANAGEMENT_CLIENT_DOMAIN=
SANDBOX_AUTH0_MANAGEMENT_CLIENT_ID=
SANDBOX_AUTH0_MANAGEMENT_CLIENT_SECRET=

Next, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start customizing your API developer portal by modifying portal.config.js. Refresh your page to see changes.

Plugins

We're focused on providing an out of the box experience with the tools your team is already using.

• @astral-dx/plugin-auth0 Auth0 - supports User Authencation, Team mangement, and API Credentials
• @astral-dx/plugin-kong Kong - Coming soon!
• @astral-dx/plugin-apigee Apigee - Coming soon!
• @astral-dx/plugin-tyk Tyk - Coming soon!
• @astral-dx/plugin-zuplo Zuplo - Coming soon!

Don't see a plugin your looking for? Reach out and let us know! contact@astral.sh

Customization

Astral DX Developer API Portal supports custom implementations for any of our core concepts:

• User Authencation
• Team Mangement
• API Credential Management
• Branding
• References
• Custom Pages coming soon!

Cusomization documentation is also coming soon!