Skip to content

API Documentation

GraphQL Endpoints

Environment Endpoint
Development https://commercial-api-dev.credplatform.com/graphql
Staging https://commercial-api-staging.credplatform.com/graphql
Production https://commercial-api.credplatform.com/graphql

Authentication

All API requests require JWT authentication:

const headers = {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
};

Common Queries

Get User Profile

query GetUser {
    user {
        id
        email
        name
        role
    }
}

Get Business Metrics

query GetMetrics {
    metrics {
        revenue
        customers
        growth
    }
}

Common Mutations

Update User

mutation UpdateUser($input: UpdateUserInput!) {
    updateUser(input: $input) {
        id
        name
        email
    }
}

Error Handling

API errors follow a standard format:

{
    "errors": [
        {
            "message": "Error description",
            "extensions": {
                "code": "ERROR_CODE",
                "statusCode": 400
            }
        }
    ]
}

Rate Limiting

  • Authenticated requests: 1000 requests/minute
  • Unauthenticated requests: 100 requests/minute

GraphQL Playground

Use the GraphQL Playground for testing queries: