API Reference
Comprehensive API documentation for various projects and services.
API Reference#
Comprehensive API Documentation
Comprehensive API documentation for various projects and services, including production Portfolio APIs, interactive OpenAPI demonstrations, and Freshworks platform integrations with real-time data access and testing capabilities.
API Platform Overview
Available APIs
Production and demonstration APIs
Methods Supported
GET, POST, PUT, DELETE operations
Rate Limit
Requests per minute per API key
Response Time
Average API response time
Uptime
API availability and reliability
Documentation Coverage
All endpoints documented
Available API Collections#
API Platform Ecosystem
Comprehensive collection of production and demonstration APIs with live testing capabilities, comprehensive documentation, and real-time access to portfolio data and services.
https://journey.thakurganeshsingh.comNo Authentication Required
All endpoints are publicly accessible
API Services & Platforms
Production APIs for project data, achievements, and portfolio information with real-time access
Node.js SDK, Neo Platform APIs, and Developer Portal APIs for Freshworks products
API key and OAuth-based authentication with security best practices
Contact form submission and communication APIs with validation
Usage analytics and performance monitoring APIs
🌐 Portfolio APIs#
Production APIs for accessing project data, newsletter subscriptions, LinkedIn publishing, and portfolio information with real-time data and comprehensive documentation.
- Methods: GET, POST
- Base URL:
https://journey.thakurganeshsingh.com/api - Authentication: Bearer token for protected endpoints
- Email Service: Powered by Resend for reliable delivery
- New Features: Newsletter subscriptions, auto-publishing, email notifications
- View Live API
- Try Newsletter (Public endpoint)
🆕 New Endpoints (v2.0)#
/newsletter- Newsletter subscriptions with professional welcome emails/linkedin-publish- Auto-publish blog posts to LinkedIn (Authenticated)/notify-subscribers- Send email notifications to subscribers (Authenticated)
🚀 Freshworks APIs#
Documentation for various Freshworks-related APIs and SDKs including:
- Freshworks API SDK: Node.js SDK for interacting with Freshworks products
- Neo Platform APIs: Custom APIs for the Neo platform with enhanced developer experience
- Developer Portal APIs: APIs for the developer documentation platform and community
API Standards & Guidelines#
Technical Implementation Details
Security
- •API key authentication for protected endpoints
- •OAuth-based authentication for advanced features
- •HTTPS-only communication for all requests
- •Rate limiting to ensure fair usage (100 req/min per key)
Integrations
- •RESTful API design with standard HTTP methods
- •JSON request and response format
- •Consistent error response structure
- •Interactive documentation and testing tools
Performance
- •Average response time under 500ms
- •99.9% uptime and availability
- •Rate limit headers included in all responses
- •Comprehensive error handling with status codes
Authentication Example#
curl -H "X-API-Key: your-api-key" https://api.example.com/endpoint
Error Response Format#
{
"error": {
"code": "ERROR_CODE",
"message": "Human readable error message",
"details": {}
}
}
API Best Practices
Rate Limiting: 100 requests per minute per API key Error Codes: Standard HTTP status codes
(200, 400, 401, 403, 404, 429, 500) Authentication: Include API key in X-API-Key header for
protected endpoints Documentation: Interactive API explorer available for each service
Quick Start Guide#
Get Started in Minutes
- Authentication Guide - Set up API keys and security 2. Portfolio API - Access project and achievement data 3. Rate Limiting - Understand usage limits and best practices
Interactive Documentation#
For interactive API exploration, use the dedicated API explorer sections for each service, featuring live testing capabilities and comprehensive examples.