Finding API Documentation
The API Builder asks you for specific details — base URL, auth type, endpoint paths, parameters, and response format. All of this comes from the API provider's documentation. Here's where to look and what to look for.
Where to Find API Docs
| Source | What It Looks Like | Examples |
|---|---|---|
| Developer Portal | A dedicated docs site with guides, reference, and examples | Stripe Docs, Twilio Docs |
| Swagger / OpenAPI | Interactive API explorer that lets you try endpoints in the browser | Often hosted at /docs or /swagger on the API's domain |
| Postman Collections | Pre-built request collections you can import and test | Published on Postman |
| README / GitHub | Documentation bundled with the project source code | Common for open-source APIs |
What to Look For
When reading API docs, gather these five pieces of information:
1. Base URL
Usually listed at the top of the docs or in a "Getting Started" section. Look for phrases like "API Base URL", "Endpoint", or "Server URL".
2. Authentication Method
Look for "Authentication", "Authorization", or "API Keys". The docs will tell you:
- What type of credential you need (API key, token, username/password)
- Where to send it (which header, query parameter, etc.)
- Where to generate the credential (usually a dashboard or settings page)
3. Endpoints
The individual operations the API supports. Each will list:
- The HTTP method (GET, POST, etc.)
- The path (
/users,/orders/{id}) - Required and optional parameters
- A description of what it does
4. Request Parameters
For each endpoint, the docs describe what parameters it accepts, where each goes (query, path, header, body), and whether they're required.
5. Response Format
Most docs include a "Response" or "Example Response" section showing sample JSON. This is exactly what you'll paste into the API Builder's JSON parser.
Testing Before Building
Before configuring an integration in the API Builder, it's smart to verify the API works as expected:
| Tool | Best For | How to Get It |
|---|---|---|
| Postman | Visual API testing with saved history | postman.com (free) |
| cURL | Quick command-line testing | Built into macOS/Linux; available for Windows |
| Browser | Simple GET requests | Just paste the URL into your browser address bar |
| Swagger UI | APIs that provide interactive docs | Hosted by the API provider |
Why test first? The API Builder trusts you to provide accurate information. If you paste a base URL that's wrong, or a sample response from an outdated version of the API, your integration will fail at runtime. A quick test confirms everything works before you build.
Next Steps
- Wizard Walkthrough — Start building your integration step by step