Documentation

Complete guides and references to help you integrate DevAPI Hub into your projects

🚀

Getting Started

Learn the basics of using DevAPI Hub, from creating an account to making your first API call.

Read Guide →
🔑

Authentication

Understand how to generate and use API keys to authenticate your requests securely.

Read Guide →
📚

API Reference

Complete reference documentation for all available APIs and endpoints.

Browse APIs →
💻

Code Examples

Ready-to-use code snippets in Python, Node.js, PHP, JavaScript, and more.

View Examples →

Rate Limits

Learn about rate limiting, how to handle limits, and upgrade your plan.

View Plans →
🛠️

Troubleshooting

Common issues and solutions to help you resolve problems quickly.

View Guide →

🚀 Getting Started

Step 1: Create an Account

Sign up for a free DevAPI Hub account to get started. You can register using your email address or connect with GitHub/Google for faster access.

Create Account

Step 2: Subscribe to an API

Browse our API catalog and subscribe to the APIs you need. Each API has detailed documentation, code examples, and usage information.

Step 3: Generate an API Key

Once subscribed, navigate to your Dashboard and generate an API key for the subscribed API. You can create multiple keys for different projects.

Step 4: Make Your First API Call

Use your API key to authenticate requests. All requests must include the API key in the header:

curl -X GET "https://devapi.autoplannerx.com/api/v1/quotes-api/random" \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

{
  "quote": "The only way to do great work is to love what you do.",
  "author": "Steve Jobs",
  "category": "motivational"
}

🔑 Authentication

API Key Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Header Format

X-API-Key: YOUR_API_KEY

💡 Note: The header name is case-insensitive. Both X-API-Key and x-api-key will work. You can also pass the API key as a query parameter: ?api_key=YOUR_API_KEY

Example Request

curl -X GET "https://devapi.autoplannerx.com/api/v1/quotes-api/random" \
  -H "X-API-Key: your-api-key-here"

Important: Each API key is tied to a specific API. Make sure you generate a key for the API you want to use from your dashboard.

Security Best Practices

  • Never expose your API key in client-side code or public repositories
  • Rotate your keys regularly for enhanced security
  • Use different keys for different projects or environments
  • Revoke compromised keys immediately from your dashboard

Error Responses

If authentication fails, you'll receive one of these error responses:

// 401 Unauthorized - Missing API Key
{
  "error": true,
  "message": "API Key is missing"
}

// 401 Unauthorized - Invalid API Key
{
  "error": true,
  "message": "Invalid API Key"
}

// 401 Unauthorized - API Key not for this service
{
  "error": true,
  "message": "Invalid API Key for this service"
}

// 404 Not Found - API not found
{
  "error": true,
  "message": "API not found"
}

Common Issues:

  • "API Key is missing" - The X-API-Key header was not provided
  • "Invalid API Key" - The API key does not exist or is inactive
  • "Invalid API Key for this service" - The API key is valid but not associated with the requested API. Generate a new key for the specific API.

💻 Code Examples

Here are ready-to-use code examples for different programming languages. Each API's detail page includes comprehensive examples for all endpoints.

JavaScript (Fetch API)

fetch('https://devapi.autoplannerx.com/api/v1/quotes-api/random', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => {
  console.log(data);
})
.catch(error => {
  console.error('Error:', error);
});

Python (requests)

import requests

url = 'https://devapi.autoplannerx.com/api/v1/quotes-api/random'
headers = {
    'X-API-Key': 'YOUR_API_KEY'
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

PHP (cURL)

$apiKey = "YOUR_API_KEY";
$apiUrl = "https://devapi.autoplannerx.com/api/v1/quotes-api/list";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-API-Key: " . $apiKey,
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $quotes = json_decode($response, true);
    // Use $quotes array
    foreach ($quotes as $quote) {
        echo $quote['quote'] . " - " . $quote['author'] . "\n";
    }
} else {
    $error = json_decode($response, true);
    echo "Error: " . $error['message'];
}

Node.js (axios)

const axios = require('axios');

axios.get('https://devapi.autoplannerx.com/api/v1/quotes-api/random', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error:', error.response?.data || error.message);
});

Quotes API Endpoints

The Quotes API provides several endpoints for accessing inspirational quotes:

  • GET /api/v1/quotes-api/random - Get a random quote
  • GET /api/v1/quotes-api/list - Get all available quotes
  • GET /api/v1/quotes-api/category/{category} - Get a random quote from a specific category

Available categories: motivational, success, wisdom, life, technology

Example: Get All Quotes

curl -X GET "https://devapi.autoplannerx.com/api/v1/quotes-api/list" \
  -H "X-API-Key: YOUR_API_KEY"

Example Response (List)

[
  {
    "quote": "The only way to do great work is to love what you do.",
    "author": "Steve Jobs",
    "category": "motivational"
  },
  {
    "quote": "Success is walking from failure to failure with no loss of enthusiasm.",
    "author": "Winston Churchill",
    "category": "success"
  }
]

💡 Tip: Visit any API's detail page to see comprehensive code examples for all available endpoints in multiple languages.

⚡ Rate Limits

Rate limits ensure fair usage and system stability. Limits are applied per API key and reset based on your plan's period.

Rate Limit Tiers

Plan Requests/Hour Period
Free 100 Hour
Premium 1,000 Hour
Enterprise 10,000+ Hour

Rate Limit Headers

Every API response includes rate limit information in the headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1640995200

Handling Rate Limits

When you exceed your rate limit, you'll receive a 429 Too Many Requests response:

{
  "error": true,
  "message": "Rate limit exceeded",
  "retry_after": 3600
}

Best Practices

  • Monitor your rate limit headers to avoid hitting limits
  • Implement exponential backoff when you receive 429 errors
  • Cache responses when possible to reduce API calls
  • Upgrade your plan if you consistently hit rate limits

🛠️ Troubleshooting

Common Issues and Solutions

401 Unauthorized Error

Problem: Your API key is missing or invalid.

Solution:

  • Verify you're including the X-API-Key header in your request (header name is case-insensitive)
  • Check that your API key is correct and hasn't been revoked
  • Ensure you're subscribed to the API you're trying to access
  • Important: Each API key is tied to a specific API. If you get "Invalid API Key for this service", generate a new key for that specific API from your dashboard
  • Generate a new API key from your dashboard if needed

429 Rate Limit Exceeded

Problem: You've exceeded your plan's rate limit.

Solution:

  • Wait for the rate limit window to reset (check X-RateLimit-Reset header)
  • Implement request caching to reduce API calls
  • Upgrade your plan for higher rate limits
  • Use multiple API keys to distribute load (Premium/Enterprise plans)

404 Not Found

Problem: The API endpoint doesn't exist or the API is inactive.

Solution:

  • Verify the endpoint URL is correct
  • Check the API documentation for the correct endpoint path
  • Ensure the API is active and available
  • Check the API status on the API details page

500 Internal Server Error

Problem: An error occurred on our servers.

Solution:

  • Retry the request after a few moments
  • Check our status page for any ongoing issues
  • If the problem persists, contact support with the request details

CORS Errors (Browser)

Problem: Cross-origin requests are blocked in the browser.

Solution:

  • Make API calls from your backend server instead of directly from the browser
  • Use a proxy server to handle CORS
  • For Enterprise plans, contact us about CORS configuration

Getting Help

If you're still experiencing issues:

📋 Quick Reference

Base URL

https://devapi.autoplannerx.com/api/v1/

Authentication

X-API-Key: YOUR_API_KEY

Response Format

JSON

HTTP Methods

GET, POST, PUT, DELETE