Basic Principles About the API's
This guide will help you get started and have your integration up and running quickly.
What it is
- The Billit API is RESTful, with predictable, resource-oriented endpoints.
- We recommend all requests to use JSON payloads; but other Content-Type are allowed. Please don't forget to set your Content-Type header.
- You can operate in two distinct modes:
- Sandbox(Test) - for building and testing safely without affecting real data.
- Production(Live) - for actual business operations once you're ready.
Authentication
- OAuth 2.0: → Required for multi-tenant integrations or advanced scenarios where applications act on behalf of multiple customers.
- OpenID Connect (OIDC) → Standards-based authentication layer built on top of OAuth 2.0, used to verify user identity and enable secure single sign-on.
- Includes support for Microsoft Entra SSO
- API Key - ⚠️Only allowed for non-commercial integrations.
Non-Commercial Integration A non-commercial integration is a personal integration developed and used exclusively by an individual or organization to automate their own administration. It is not shared, distributed, sold, or otherwise made available to third parties, and it has no commercial purpose or business model attached.
Do not share your API-key with others, Billit will never ask for your API key.
Tools & Getting Started Resources
- View our full interface specification in OpenAPI / Swagger here: Billit Swagger
- Want to hit the ground running? Use:
- Our Quick Start Guide guide for step-by-step direction.
- The Postman Collection (Run in Postman) to test endpoints immediately.
Support
We want your integration process to be smooth. If you need help at any stage, check out what developer support we offer: To find out what support you can receive, please navigate to What support can I get as a developer?
Updated 24 days ago
What’s Next