Developer Portal
Getting Started with Developer Portal
A developer portal gives your API's users a place to read documentation, sign in, and test requests. This tutorial creates a portal with Zudoku, Zuplo's open-source documentation framework, using a sample Todo API.
Choose a workflow to publish the reference docs and connect API key management. You assign a key to a consumer (the person or application calling your API), then sign in to test it. You need an email address you can access for the sign-in step.
Choose a workflow to start
Pick one of these three options to open your tutorial. You can switch workflows later in the guide.
Zuplo PortalConfigure your project in the browser with the visual Route Designer and built-in testing tools.What you'll needa browser and a free Zuplo accountUse the PortalLocal with an editorCreate a project with the Zuplo CLI, edit its files, and test changes on your machine.What you'll needNode.js 24+, a terminal, and your editorUse an editorLocal with an AI agentUse a guided prompt with Claude Code, Cursor, or Codex, then review and test the changes.What you'll needNode.js 24+ and an AI coding agentUse an AI agent
What you'll build
About 15 min for the tutorialCreate a developer portal for a sample API, then sign in and test a request with an assigned API key.
- Publish API reference docs from OpenAPI
- Assign an API key to a consumer
- Sign in and send an authenticated request