HookAPI

Contact Get Started

Build, Test, and Document Your APIs with Ease

The complete platform for API development that helps you create, test, and share your APIs faster than ever before.

Get Started for Free Explore Features

Powerful Features for API Development

Everything you need to build and manage your APIs in one place

API Documentation

Create beautiful, interactive API documentation that your users will love.

API Testing

Test your endpoints with a powerful interface and save test scenarios.

Version Control

Keep track of changes with built-in versioning for your API documentation.

Authentication

Secure your APIs with multiple authentication methods.

Mock Servers

Create mock responses for your API endpoints for faster development.

Analytics

Monitor API usage and performance with detailed analytics.

How It Works

Get started with HookAPI in just a few simple steps

Create Your API Project

Define Your Endpoints

Use our intuitive interface to define your API endpoints, parameters, and responses.

Test and Document

Test your API endpoints and automatically generate beautiful documentation.

Share and Collaborate

Invite team members and share your API documentation with the world.

API Documentation

Comprehensive documentation to help you integrate with our API

Authentication

All API requests require authentication using an API key that should be included in the header of each request.

POST /api/v1/auth/token

Generate a new authentication token.

Request

curl -X POST https://api.hookapi.online/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"api_key": "your_api_key", "secret": "your_api_secret"}'

Response

{
  "status": "success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": "2025-08-21T19:33:49Z"
  }
}

Users

Endpoints for managing user accounts and profiles.

GET /api/v1/users

Retrieve a list of users.

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Number of records per page (default: 10)

Request

curl -X GET https://api.hookapi.online/api/v1/users?page=1&limit=10 \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": "success",
  "data": {
    "users": [
      {
        "id": 1,
        "username": "john_doe",
        "email": "john@example.com",
        "created_at": "2025-01-15T10:30:00Z"
      },
      {
        "id": 2,
        "username": "jane_smith",
        "email": "jane@example.com",
        "created_at": "2025-02-20T14:15:00Z"
      }
    ],
    "pagination": {
      "total": 42,
      "pages": 5,
      "page": 1,
      "limit": 10
    }
  }
}

POST /api/v1/users

Create a new user.

Request

curl -X POST https://api.hookapi.online/api/v1/users \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "new_user",
    "email": "new@example.com",
    "password": "securepassword",
    "name": "New User"
  }'

Products

Endpoints for managing product information.

GET /api/v1/products

Retrieve a list of products.

Code Example (JavaScript)

// Using fetch API
const fetchProducts = async () => {
  try {
    const response = await fetch('https://api.hookapi.online/api/v1/products', {
      method: 'GET',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      }
    });
    
    const data = await response.json();
    return data;
  } catch (error) {
    console.error('Error fetching products:', error);
  }
};

Orders

Endpoints for managing customer orders.

POST /api/v1/orders

Create a new order.

Code Example (Python)

import requests
import json

url = "https://api.hookapi.online/api/v1/orders"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

data = {
    "customer_id": 123,
    "products": [
        {"product_id": 456, "quantity": 2},
        {"product_id": 789, "quantity": 1}
    ],
    "shipping_address": {
        "street": "123 Main St",
        "city": "Anytown",
        "state": "CA",
        "zip": "12345",
        "country": "USA"
    }
}

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

Need more detailed documentation?

Contact Our Support Team