API Documentation

Overview

The TestCrew API is designed as a RESTful API and exchanges data in JSON format. You can automate app listing management, test status checking, and user information retrieval from external sources.

Base URL

https://testcrew-api.eerf0309.workers.dev/api

Response Format

All API responses are returned in the following format:

{
  "success": true,
  "data": {
    // Response data
  }
}

Error response:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Error message"
  }
}

Authentication

TestCrew API supports two authentication methods:

1. API Key Authentication (Recommended)

For external API calls, we recommend using API key authentication. Include X-API-Key in the request header.

curl -X GET "https://testcrew-api.eerf0309.workers.dev/api/users/me" \
  -H "X-API-Key: tc_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

2. JWT Authentication

For API calls from within the app, use the JWT token obtained at login. Include Authorization in the request header.

curl -X GET "https://testcrew-api.eerf0309.workers.dev/api/users/me" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Obtaining API Keys

API keys can be created from the settings screen within the TestCrew app.

API Key Creation Steps

1. Open the TestCrew app and navigate to the profile screen
2. Tap the "API Management" section
3. Tap "Create new API key"
4. Enter a name for the key (e.g., intended use) and create it
5. Save the displayed API key in a secure location

Endpoints

Users

{
  "success": true,
  "data": {
    "id": "uuid",
    "email": "user@example.com",
    "name": "Username",
    "avatar": "https://...",
    "credits": 24,
    "isPremium": false,
    "premiumExpiresAt": null,
    "discordId": "123456789",
    "createdAt": "2026-01-01T00:00:00.000Z"
  }
}

App Listings

Tests

API Key Management

{
  "success": true,
  "data": {
    "message": "API key created successfully",
    "apiKey": {
      "id": "uuid",
      "name": "My API Key",
      "key": "tc_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2026-01-25T00:00:00.000Z"
    },
    "warning": "This is the only time the API key will be shown."
  }
}

Error Handling

The API returns errors using a combination of HTTP status codes and error codes.

Common HTTP Status Codes

Common Error Codes

Rate Limits

To ensure API stability, the following rate limits apply:

• Up to 60 requests per minute
• Exceeding rate limits returns 429 Too Many Requests