Developer Portal

SoftKeyBazar AI & Sitemap REST API

Integrate automated sitemap crawling, AI SEO priority scoring, and index management into your CI/CD pipelines or CMS.

🔐 Authentication & Security

Premium Exclusive

All API endpoints require authentication using a secret API key. API access is strictly available to users with an Active Premium Subscription. Pass your API key via the HTTP Authorization header or X-API-Key header:

Authorization: Bearer YOUR_PREMIUM_API_KEY # OR X-API-Key: YOUR_PREMIUM_API_KEY
⚠️ Note: API requests made with free plan keys or expired subscriptions will receive HTTP 403 Forbidden with instruction to renew via bKash.
POST /api/v1/sitemap.php

Initiate crawler on target website URL, discover internal links, and generate a downloadable standard XML sitemap.

Request Headers

Content-Type: application/json Authorization: Bearer skb_live_xxxxxxxxxxxxxxxxxxxxxxxx

Request Body (JSON)

{ "url": "https://example.com", "format": "xml", "max_urls": 2000, "include_images": true, "include_videos": true, "enable_ai": true }

Success Response (HTTP 200)

{ "success": true, "message": "Sitemap generated successfully", "total_urls": 128, "duration": 2.41, "download_url": "/downloads/sitemaps/sitemap_20261122_example.xml", "gzip_download_url": "/downloads/sitemaps/sitemap_20261122_example.xml.gz" }
POST /api/v1/ai.php

Run SoftKeyBazar AI (powered by xingchiapi.com) SEO audit and dynamic crawl priority scoring on specified URLs.

Request Body (JSON)

{ "action": "seo_audit", "url": "https://example.com/products/headphones", "title": "Wireless Bluetooth Headphones Pro", "images_count": 4 }

Success Response (HTTP 200)

{ "success": true, "data": { "url": "https://example.com/products/headphones", "score": 90, "rating": "Excellent", "recommendations": [] } }

💻 Code Implementation Examples

Python (requests)
import requests url = "/api/v1/sitemap.php" headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" } payload = { "url": "https://example.com", "format": "xml", "include_images": True, "enable_ai": True } response = requests.post(url, json=payload, headers=headers) print(response.json())
Node.js (Fetch)
const response = await fetch("/api/v1/sitemap.php", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" }, body: JSON.stringify({ url: "https://example.com", format: "xml", include_images: true }) }); const data = await response.json(); console.log(data);