Developer Documentation

Comprehensive guides, API references, and tutorials to help you integrate and leverage our services effectively. From quick start guides to advanced implementation examples, we've got everything you need to build amazing applications.

50+

API Endpoints

10+

SDKs Available

99.9%

Uptime

Installation

Get started with Gridalyze in just a few minutes. Choose your preferred language and follow the installation guide.

npm install gridalyze-sdk

// Initialize the SDK
import Gridalyze from 'gridalyze-sdk';

const gridalyze = new Gridalyze({
    apiKey: 'your-api-key-here',
    environment: 'production'
});
pip install gridalyze

# Initialize the SDK
from gridalyze import Gridalyze

gridalyze = Gridalyze(
    api_key='your-api-key-here',
    environment='production'
)
composer require gridalyze/php-sdk

// Initialize the SDK
use Gridalyze\Gridalyze;

$gridalyze = new Gridalyze([
    'api_key' => 'your-api-key-here',
    'environment' => 'production'
]);
# Set your API key
export GRIDALYZE_API_KEY="your-api-key-here"

# Make your first request
curl -X GET "https://api.gridalyze.in/v1/status" \
  -H "Authorization: Bearer $GRIDALYZE_API_KEY"

Authentication

All API requests require authentication using your API key. You can find your API keys in the dashboard.

API Key Security

Keep your API keys secure and never expose them in client-side code. Use environment variables for production applications.

Bearer Token Authentication

// Include your API key in the Authorization header
const response = await fetch('https://api.gridalyze.in/v1/projects', {
    headers: {
        'Authorization': 'Bearer your-api-key-here',
        'Content-Type': 'application/json'
    }
});

Making Your First Request

Let's create a simple project to get you started with the Gridalyze API.

Create a New Project

// Create a new web development project
const project = await gridalyze.projects.create({
    name: 'My Awesome Website',
    type: 'website',
    description: 'A modern website for my business',
    budget: 5000,
    timeline: '4 weeks'
});

console.log('Project created:', project.id);

Check Project Status

// Get project details
const projectDetails = await gridalyze.projects.get(project.id);

console.log('Project status:', projectDetails.status);
console.log('Progress:', projectDetails.progress + '%');

Projects API

Manage your web development projects through our comprehensive API.

GET /api/v1/projects List Projects

Retrieve a list of all projects for the authenticated user.

Parameters

Parameter Type Required Description
page integer No Page number (default: 1)
limit integer No Items per page (default: 20, max: 100)
status string No Filter by status (draft, active, completed)

Example Response

{
    "success": true,
    "data": {
        "projects": [
            {
                "id": "proj_123456",
                "name": "E-commerce Website",
                "type": "website",
                "status": "active",
                "progress": 75,
                "created_at": "2024-01-15T10:30:00Z",
                "updated_at": "2024-01-20T14:45:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 20,
            "total": 1,
            "pages": 1
        }
    }
}
POST /api/v1/projects Create Project

Create a new web development project.

Request Body

{
    "name": "My Website",
    "type": "website",
    "description": "A modern business website",
    "budget": 5000,
    "timeline": "4 weeks",
    "features": ["responsive", "cms", "seo"],
    "contact_info": {
        "email": "client@example.com",
        "phone": "+1234567890"
    }
}

SDKs & Libraries

Choose from our official SDKs and libraries to integrate Gridalyze into your applications.

JavaScript SDK

Official JavaScript/Node.js SDK for browser and server-side applications.

v2.1.0 50K+ downloads
Install Documentation

Python SDK

Python SDK for building applications with Gridalyze APIs.

v1.8.2 25K+ downloads
Install Documentation

PHP SDK

PHP SDK for server-side applications and WordPress integrations.

v1.5.1 15K+ downloads
Install Documentation

React Hook

React hooks for easy integration with React applications.

v1.2.0 10K+ downloads
Install Documentation

Tutorials

Step-by-step guides to help you build amazing applications with Gridalyze.

Building an E-commerce Website

Learn how to create a complete e-commerce solution with payment integration and inventory management.

Beginner 45 min
Start Tutorial

Setting Up VPS Hosting

Configure and deploy your applications on our managed VPS hosting platform.

Intermediate 30 min
Start Tutorial

Payment Gateway Integration

Integrate Stripe, PayPal, and other payment gateways into your applications.

Intermediate 60 min
Start Tutorial

CMS Development

Build custom content management systems with advanced features and user management.

Advanced 90 min
Start Tutorial

Code Examples

Ready-to-use code examples for common use cases and integrations.

Create a Project

const project = await gridalyze.projects.create({
    name: 'My Website',
    type: 'website',
    budget: 5000
});
project = gridalyze.projects.create(
    name='My Website',
    type='website',
    budget=5000
)

Process Payment

const payment = await gridalyze.payments.create({
    amount: 5000,
    currency: 'usd',
    payment_method: 'stripe'
});
payment = gridalyze.payments.create(
    amount=5000,
    currency='usd',
    payment_method='stripe'
)