CodeBayChecker.online API Documentation

Comprehensive documentation for integrating with CodeBayChecker.online services

OpenAPI Specification

Our API follows the OpenAPI 3.0 specification. You can download the full specification or explore it interactively below.

Download OpenAPI Spec Interactive API Explorer

Authentication

API Key Authentication

Most endpoints require API key authentication. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

For user-specific actions, we support OAuth 2.0 authentication:


// Step 1: Redirect users to
https://codebaychecker.online/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code

// Step 2: Exchange code for token
POST https://codebaychecker.online/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=YOUR_REDIRECT_URI&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

Endpoints

Website Check

GET/api/v1/check

Check a website's AI agent readiness score and get detailed analysis.

Query Parameters

Parameter	Type	Required	Description
url	string	Yes	The website URL to check
depth	integer	No	Crawl depth (default: 3, max: 10)

Response Format


{
  "overallScore": 72,
  "pillars": {
    "structuredData": {
      "score": 85,
      "status": "good",
      "description": "Good structured data implementation"
    },
    "apiReadiness": {
      "score": 62,
      "status": "average",
      "description": "API documentation needs improvement"
    },
    "contentClarity": {
      "score": 68,
      "status": "average",
      "description": "Content structure could be enhanced"
    }
  },
  "recommendations": [
    {
      "title": "Add Schema.org Product markup",
      "description": "Implement product schema markup",
      "priority": "high"
    }
  ]
}

Certification

POST/api/v1/certify

Request certification for a website that meets all requirements.

Request Body


{
  "websiteUrl": "https://example.com",
  "contactEmail": "owner@example.com",
  "paymentMethod": "credit_card",
  "paymentToken": "tok_visa"
}

Response Format


{
  "success": true,
  "certificationId": "CBY-2023-12345",
  "validUntil": "2024-06-01T00:00:00Z",
  "badgeUrl": "https://codebaychecker.online/badge/CBY-2023-12345.svg"
}

Certification Verification

GET/api/v1/verify/{certificationId}

Verify a certification ID. This endpoint is specifically designed for AI agents to verify certifications.

Path Parameters

Parameter	Type	Description
certificationId	string	The certification ID to verify

Response Format


{
  "valid": true,
  "websiteUrl": "https://example.com",
  "issuedAt": "2023-06-01T00:00:00Z",
  "validUntil": "2024-06-01T00:00:00Z",
  "status": "active"
}

Rate Limits

Our API implements rate limiting to ensure fair usage:

Plan	Rate Limit	Burst Limit
Free	60 requests/hour	10 requests/minute
Pro	1000 requests/hour	100 requests/minute
Enterprise	10000 requests/hour	1000 requests/minute

Rate limit headers are included in all API responses:


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