API Documentation

Complete reference for all API endpoints and features

API Endpoints

Introduction

Welcome to our comprehensive API documentation

Fast & Reliable

High-performance API with low latency

Secure

Enterprise-grade security and encryption

Comprehensive

Complete set of endpoints for all needs

Base URL

https://devsouqhub.com/api/v1

Authentication

How to authenticate with our API

API Key Authentication

Authenticate using your API key

GET /api/v1/courses?api_key=YOUR_API_KEY

Bearer Token

Bearer token description

Authorization: Bearer YOUR_TOKEN

Rate Limiting

Rate limiting description

Plan Rate Limit Burst
Free 60 Requests per hour 10 Requests per minute
Basic 500 Requests per hour 30 Requests per minute
Premium 2000 Requests per hour 60 Requests per minute
Enterprise custom custom

Rate Limit Headers

Rate limit headers description

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 56
X-RateLimit-Reset: 1623456789

Authentication

Authentication endpoints description

POST
/api/v1/auth/login

API login description

Parameters

Name Type This field is required Description
email string User's email address
password string User Password

response

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "username": "johndoe",
    "email": "john@example.com"
  }
}

Error Handling

Error handling description

Status Code Error Code Description
400 invalid_request Error: Invalid Request
401 unauthorized Error: Unauthorized
403 forbidden Error: Forbidden
404 not_found Error: Not Found
422 validation_error Error: Validation
429 rate_limit_exceeded Error: Rate Limit Exceeded
500 server_error Error: Server Error
503 service_unavailable Error: Service Unavailable

error_response_example

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid.",
    "details": {
      "email": ["The email field is required."],
      "password": ["The password must be at least 8 characters."]
    }
  }
}

SDK Libraries

sdk_libraries_description

JavaScript

JavaScript SDK description

GitHub docs

PHP

PHP SDK description

GitHub docs

Python

Python SDK description

GitHub docs

Other Languages

Other languages

GitHub docs

Changelog

v1.3.0
2023-08-15

New features and improvements

  • ...
  • ...
  • ...
v1.2.0
2023-05-20

New Endpoints

  • ...
  • ...
  • ...
v1.1.0
2023-03-10

API Improvements

  • ...
  • ...
v1.0.0
2023-01-15

Initial Release

  • ...
  • ...
  • ...