Skip to main content

Choose Your Path

Use this page to pick the fastest path based on your role and objective.

What this page covers​

  • Who each docs path is for
  • What to do in the first 30 minutes
  • How to know you are on the right track

Platform admin path​

Use this path when: you own deployment, governance, and production readiness.

  1. Read Architecture Surfaces.
  2. Review Architecture.
  3. Define access model in Security.
  4. Validate runtime visibility in Request Logs.
  5. Use Zerq Copilot for operations tasks and diagnostics in plain language.

API builder path​

Use this path when: you are publishing and operating API products.

  1. Start with Publish First API.
  2. Build API contracts in Managing APIs.
  3. Add execution logic in Workflows. Multi-tab editing is supported via Live updates (SSE) on the Workflow Builder.
  4. Validate with Testing Endpoints.

API consumer path​

Use this path when: you are consuming published APIs from the portal.

  1. Open Developer Portal Overview.
  2. Follow Getting Access.
  3. Run test calls in Testing Console.
  4. Optionally use Zerq Copilot for Gateway in the portal for natural-language discovery and calls (profile-scoped).
  5. Export integration artifacts from cURL and OpenAPI.

Security and compliance path​

Use this path when: you design auth, policy, and audit controls.

  1. Start with Access Control Overview.
  2. Pick profile auth model in Authentication Methods.
  3. Review controls in Security Overview.
  4. Validate accountability in Audit and Compliance.

AI operator path​

Use this path when: you connect AI clients and operate MCP safely.

  1. Start with AI and MCP Overview.
  2. Configure runtime calls with Gateway MCP.
  3. Configure control-plane automation with Management MCP.
  4. Onboard client tools from AI Clients.

Success check​

You chose the right path if you can complete one working request in your domain:

  • Platform admin: healthy deployment and visible logs
  • Platform admin (AI): one management task completed via the Zerq Copilot for Management panel
  • API builder: one published route returning expected response
  • Consumer: one portal test request succeeds
  • Security team: one allow and one deny policy test behaves as expected
  • AI operator: one MCP tool call succeeds with scoped access

Next steps​