Integrating via the HTTP API
This page will help you get started with SINAI's API.
Overview
The SINAI platform exposes an HTTP-based API for programmatic interaction with customer accounts. This API is built according to the OpenAPI 3.0 specification, ensuring easy integration with modern tools including iPaaS platforms (like Workato, MuleSoft, Tray.io, etc.), custom applications, and workflow engines.
Key Features
- Standards-compliant OpenAPI documentation (available in JSON/YAML).
- Secure authentication using OAuth 2.0, supporting both:
- Client Credentials Flow (for server-to-server integration).
- Authorization Code Flow (for delegated access with user consent).
- Well-structured RESTful endpoints for managing emissions data, scenario modeling, reporting, and more.
OpenAPI Spec Access
The full OpenAPI definition is available at https://docs.sinai.com/reference/accessing-the-api. It can be used with:
- Postman
- Swagger UI
- Code generators like openapi-generator-cli for generating client SDKs (Python, TypeScript, etc.)
Support and Contact
If you need access to credentials, scopes, or sample workflows:
Reach out to your dedicated SINAI support contact.
Or email [email protected] for assistance.
Updated 4 months ago
What’s Next