API
Use the OWOX Data Marts API to connect external tools, scripts, local agents, and custom applications to your OWOX Data Marts project.
API access is an integration and automation layer on top of OWOX Data Marts concepts such as Data Marts, Storages, and Destinations. Use it when you need terminal access, scripted automation, TypeScript or JavaScript integrations, or direct HTTP API inspection.
Choose an API access path
Section titled “Choose an API access path”| Need | Use |
|---|---|
| Create credentials for external tools | API Keys |
| Work from a terminal, CI job, or local agent | owox-ctl |
| Build with TypeScript or JavaScript | @owox/api-client |
| Inspect the HTTP API contract | OpenAPI and Swagger UI |
Access options
Section titled “Access options”API Keys authenticate external tools and integrations without an interactive browser session. Create an API key before using other API access options.
owox-ctl is the OWOX Data Marts Control CLI for terminal, CI, automation, and local agent usage.
@owox/api-client is the TypeScript/JavaScript API Client for custom applications, scripts, and internal tools.
OpenAPI and Swagger UI help developers inspect the raw HTTP API endpoints, request schemas, and response schemas.