Getting Started Guide

In this tutorial, you will learn about Getting Started Guide. We cover key concepts, practical examples, and best practices to help you master this topic.

A getting started guide is the first page new API users read, taking them from zero knowledge to a successful API call in under five minutes with clear steps, copy-paste code examples, and no skipped prerequisites.

What You'll Learn

How to structure a getting started guide, what prerequisites to document, how to walk through API key acquisition, how to write a first-request example that works on copy-paste, and how to keep the guide focused on the fastest path to success.

Why It Matters

The getting started guide is the highest-traffic page in any API documentation set. A great guide converts evaluators into users within minutes. A poor guide with missing steps or broken examples drives developers to competitors with easier onboarding.

Real-World Use

Stripe's getting started guide shows a complete payment flow in under 20 lines of code. Developers can copy the example, paste their API key, and Process a payment within minutes. This frictionless onboarding is a key reason for Stripe's developer adoption.

Getting Started Flow

flowchart TD
  A[Developer arrives] --> B[Prerequisites]
  B --> C[Get API Key]
  C --> D[Install SDK / Tools]
  D --> E[First Request]
  E --> F{Success?}
  F -->|Yes| G[Next Steps]
  F -->|No| H[Troubleshooting]
  H --> E
  A:::current
  classDef current fill:#f90,color:#fff,stroke:#333,stroke-width:2px

Prerequisites Section

List everything the developer needs before starting. Be specific about versions.

## Prerequisites

Before you start, make sure you have:

- A **DodaTech account** — [Sign up free](https://dodatech.com/signup)
- **Python 3.9+** installed — Check with `python --version`
- **pip** package manager — Check with `pip --version`
- A **text editor** or IDE of your choice

API Key Acquisition

Show exactly how to get credentials. Include screenshots or step-by-step instructions.

## Get Your API Key

1. Log in to the [DodaTech Dashboard](https://dashboard.dodatech.com)
2. Navigate to **Settings > API Keys**
3. Click **Generate New Key**
4. Enter a name for the key (e.g., "Development")
5. Copy the key and store it securely

> Store your API key in an environment variable, never in code.
> Durga Antivirus Pro scans repos for accidentally committed keys.

```bash
export DODATECH_API_KEY="your-api-key-here"

## Installation

Show the fastest installation path, then optional alternatives.

```bash
# Install the Python SDK
pip install dodatech-sdk

# Verify installation
python -c "import dodatech; print(dodatech.__version__)"
# Expected output: 2.1.0

First Request

This is the most important section. Provide a complete, working example that the developer can copy, paste their API key, and run.

import os
from dodatech import Client

# Initialize the client with your API key
client = Client(api_key=os.environ["DODATECH_API_KEY"])

# List your files
files = client.files.list(per_page=5)

print(f"Found {len(files)} files:")
for file in files:
    print(f"  - {file.name} ({file.size_bytes} bytes)")

# Expected output:
# Found 3 files:
#   - report.pdf (1048576 bytes)
#   - data.csv (256000 bytes)
#   - image.png (5242880 bytes)

First Compression

Show a slightly more advanced example using the core feature.

import os
from dodatech import Client

client = Client(api_key=os.environ["DODATECH_API_KEY"])

# Compress a file from a URL
job = client.files.compress(
    file_url="https://example.com/sample.pdf",
    format="zip"
)

print(f"Compression job created: {job.job_id}")
print(f"Status: {job.status}")

# Wait for completion
import time
while job.status not in ("completed", "failed"):
    time.sleep(2)
    job = client.jobs.get(job.job_id)

if job.status == "completed":
    print(f"Compressed! {job.output_size} bytes")
    print(f"Download: {job.download_url}")
else:
    print(f"Job failed: {job.error}")

# Expected output:
# Compression job created: c7f3a2b1-...-1d2e3f4a5b6c
# Status: pending
# Compressed! 258432 bytes
# Download: https://api.dodatech.com/v2/download/...

Next Steps

After the first successful call, guide the developer to what they should read next.

## Next Steps

You've made your first API call. Here's what to learn next:

- **[API Reference](/api/reference)** — Explore all available endpoints
- **[Authentication Guide](/api/auth)** — Understand scopes and security
- **[Error Handling](/api/errors)** — Learn how to handle API errors
- **[SDK Documentation](/api/sdk)** — Full Python SDK reference

Common Mistakes

1. Skipping Prerequisites

Starting the guide with code examples before listing required accounts, tools, or permissions causes developers to hit errors immediately.

2. No Working API Key Instructions

Showing code examples without explaining where to get credentials forces developers to search the dashboard or guess.

3. Example Code That Does Not Work

Untested examples with typos, missing imports, or wrong method names destroy trust instantly. Test every example in the guide before publishing.

4. Too Many Options on First Page

Showing five different ways to do the same thing overwhelms beginners. Show the single fastest path first, then link to alternatives.

5. No Expected Output

Code examples without expected output leave developers wondering if their code worked correctly. Always show what the output should look like.

6. Assuming Platform Knowledge

Showing Python examples when your audience might use JavaScript, or vice versa. Provide examples in the most common language for your primary audience.

7. Dead Links

Links to dashboard pages that redirect or no longer exist create frustration. Verify every link in the getting started guide before each deployment.

Practice Questions

1. What is the most important section of a getting started guide?

The first request section with a complete, copy-paste example that produces visible output. Developers should go from reading to a successful API call in under five minutes.

2. Why should API keys be stored in environment variables?

Environment variables keep keys out of source code, preventing accidental commits to version control. Durga Antivirus Pro scans repositories for committed credentials.

3. How do you keep the getting started guide focused?

Show only the fastest path to a successful call. Link to reference documentation, advanced guides, and alternative languages instead of including them inline.

4. What should you include after the first successful API call?

Next steps that guide the developer to the API reference, authentication guide, error handling documentation, and SDK reference.

5. Challenge: Write a getting started guide for a public API you use. Include prerequisites, API key instructions, installation, first request code example with expected output, and next steps. Keep the entire guide under 500 words.

FAQ

Mini Project: Write a Getting Started Guide

Write a getting started guide for a real or fictional API. Include prerequisites with version numbers, API key acquisition steps, installation command, a complete first-request code example with expected output, and next steps with links. Test every code example before finalizing.

What's Next

Now that developers are onboarded, secure your API with clear Authentication Documentation. Then explore Error Documentation to help developers handle failures gracefully.