Get Started

API publishers: follow these three steps to get started with a better developer experience for onboarding, educating, and inspiring your API consumers.

1. Create good documentation with [The Good Documentation Checklist]
2. [Set Up Your First Public Workspace in 5 Easy Steps]
3. [Link Your Docs to the Public Workspace] for a Better Developer Experience

Examples of great public workspaces

• [Mercedes-Benz automotive]
• [Belvo open banking API for Latin America]
• [ArcGIS Location Services]

Examples of great team profiles

• Esri
• [Meta]

Examples of custom environments

Such as [pre-filled environments via the Run in Qodex button]

• MongoDB
• Belvo

Examples of Run in Qodex button placement

• [Infobip] bundles collection and environment in a workspace description
• Okta provides a button for each API
• Brex provides a button for each API

Additional resources

• [Top 25 API Onboarding Experiences]
• [Increasing Adoption of an API with a Public Workspace]
• [Design your own style guide with this public workspace linter]

Video resources

Don't feel like reading? Check out these videos.

• Documentation video
• Creating a Workspace video
• Checklist for a Great Team Profile video
• Public Workspaces video
• Contributing to Public Workspaces video
• Public API Network video
• Workspace Linter Using a Style Guide video