🚧 This website is under construction
Schedules 0
Upcoming in the next hour
Manage
No enabled tasks scheduled within the next 60 minutes.
CadFiles API

API access for automation, integrations, and reporting

CadFiles provides API patterns that scale from “simple & affordable” to “enterprise-grade”. Start with REST + webhooks, then add async jobs, streaming updates, or GraphQL when you need it.

Affordable-first approach: we prioritize REST/JSON, webhooks, and bulk endpoints because they deliver the most value with the lowest infrastructure cost.
API concepts

API types you can afford (recommended order)

These are the integration styles most SaaS products use — listed by cost/complexity.

REST / JSON API

Standard endpoints for companies, financial datasets, templates, and exports.

Cost: Low Best for: public + partner Tooling: OpenAPI

Webhooks

Push events to clients (import finished, report generated, dataset updated).

Cost: Low Best for: real-time integrations Needs: signatures

Bulk endpoints (CSV/JSON/ZIP)

Export large datasets or import mappings in one operation.

Cost: Low–Medium Best for: data teams Works with queues

Async jobs + polling

Start a long task, return a job id, poll status, download result.

Cost: Medium Best for: PDF/report generation Queue-based

Server-Sent Events (SSE)

Streaming progress logs for imports and report builds (simple, browser-friendly).

Cost: Medium Best for: dashboards Nice UX

GraphQL

Flexible queries when clients need “exact fields only” across many objects.

Cost: Medium–High Best for: complex UI Careful: abuse

API Gateway

Central entry point for auth, rate limits, logs, routing.

Cost: Medium–High Best for: multi-service Optional early

gRPC

Fast binary service-to-service APIs (usually internal only).

Cost: High Best for: microservices Not needed early

Event streaming (Kafka/Rabbit)

Enterprise pipeline for large-scale ingestion and integrations.

Cost: High Best for: huge scale Later stage

Core API concepts we apply

These are the reliability & security fundamentals (like your inspiration image).

Reliability

  • Rate limiting and throttling to protect the platform
  • Timeouts to prevent requests from blocking resources
  • Idempotency for safe retries on write operations
  • Pagination, filtering, sorting for predictable performance
  • Caching headers where safe and beneficial

Security

  • Authentication: API keys / tokens / OAuth (as needed)
  • Authorization: roles & permissions (least privilege)
  • Versioning: evolve APIs without breaking clients
  • Clear HTTP status codes + structured error responses
  • Audit-friendly logs for support and debugging

Quickstart (example)

This is a sample shape of endpoints (adjust to your real routes later).

# List companies (paginated)
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://cadfiles.ai/api/v1/companies?page=1&per_page=25

# Get one company
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://cadfiles.ai/api/v1/companies/123
# Start a report build (async)
curl -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  https://cadfiles.ai/api/v1/reports \
  -d '{"company_id":123,"layout_id":55,"years":[2023,2024]}'

# Poll job status
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://cadfiles.ai/api/v1/jobs/abcd-1234
Docs suggestion: expose an OpenAPI (Swagger) spec early — it’s the cheapest way to make your API usable and “professional”.
Import activity