API Reference

RESTful API for programmatic access to DFM analysis, board management, and order creation.

Authentication

All API endpoints require Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Note: API keys are managed from your Account page and are separate from user sessions.

Base URL

https://asappcb.com/api

Available Endpoints

Method Path Description
POST /api/v1/jobs/{job_id}/retry retry_job Details →
POST /v1/boards Upload and store a Gerber zip file for later analysis Details →
GET /v1/checks List all runnable DFM checks Details →
POST /v1/dfm Run DFM checks on a Gerber zip file Details →
POST /v1/dfm-runs Create an auditable DFM analysis run Details →
GET /v1/dfm-runs/{dfm_run_id} Retrieve a stored DFM analysis run Details →
GET /v1/order-intents List order intents for the authenticated user Details →
POST /v1/order-intents Create a new draftable order intent Details →
GET /v1/order-intents/{order_intent_id} Retrieve a specific order intent Details →
PATCH /v1/order-intents/{order_intent_id} Update a draft order intent Details →
GET /v1/order-intents/{order_intent_id}/quotes List all quote snapshots for an order intent Details →
POST /v1/order-intents/{order_intent_id}/requote Create a new quote from an order intent Details →
POST /v1/order-intents/{order_intent_id}/submit Submit an order intent to create quote and order Details →
GET /v1/orders list_my_orders Details →
POST /v1/orders Create an order from a quote Details →
GET /v1/orders/{order_id} Fetch order status and tracking information Details →
POST /v1/quotes Create a deterministic quote from a Gerber zip or DFM run Details →
GET /v1/quotes/{quote_id} read_quote Details →

Error Responses

Errors return a consistent format with an HTTP status code and detail object:

{
  "detail": {
    "code": "error_code",
    "message": "Human readable error message",
    "details": {}
  }
}

API Versioning

The API is versioned using URL paths. Current version: v1

All endpoints are prefixed with /api/v1/. We maintain backward compatibility within each major version.

Interactive Documentation

For interactive API testing and exploration:

  • Swagger UI — Test endpoints directly in your browser
  • ReDoc — Alternative documentation format