A developer-focused tour that walks technical users through the process of connecting to your API, generating keys, making a first request, and verifying the response. This template bridges the gap between documentation and hands-on implementation.
Show this tour when a user navigates to the API settings, developer console, or integrations page for the first time. It is also useful after a developer signs up specifically to use your API and lands on the getting-started page.
Display a modal that briefly explains what your API enables, links to the full documentation, and outlines the three steps to get connected: generate a key, make a request, verify the response.
Highlight the "Create API Key" button, explain the difference between test and production keys if applicable, and prompt the user to generate their first key.
Once the key is generated, highlight the copy button and warn the user that the key will not be shown again. Suggest storing it in an environment variable rather than hardcoding it.
Display a code snippet (cURL or SDK) pre-filled with the user's new API key and a simple endpoint. Explain what each part of the request does — method, headers, body.
Point to the API logs or response panel and explain how to confirm that the request succeeded. Highlight common error codes and what they mean for quick troubleshooting.
Link to the full API reference, SDKs in different languages, and a Postman collection. Suggest a more advanced endpoint to try next to keep the developer engaged.
Sign up for Produktly and use this template to get started in minutes.
Start free trial