Exchange will be rebuilt separately and is unavailable through the API or CLI. Availability in this release

API and CLI documentation

Manage your Binadit services from an application or your terminal. Start with your company, grant only the access you need, and keep every change traceable.

Code examples in four languages: Python, JavaScript / TypeScript, PHP, C#

Availability

The API is enabled on this environment. Your account capabilities and granted permissions determine which actions are available.

Every customer can use the API and CLI through the public preview. Company permissions, scopes and additional verification determine which actions a connection can perform. Read the preview conditions

Choose how you want to connect

Start with the CLI

For people managing services. Sign in in your browser and let the CLI store its session in your operating system’s credential store.

Terminal

binadit login
binadit accounts list
binadit whoami

Connect an application

For applications and automation. Create a separate integration with an explicit company, purpose, permissions and expiry date.

API and integrations

Your first connection

Open API and integrations in your company’s account menu.
Use browser login for the CLI, or create a named integration for your own application.
Select the company and the smallest set of permissions needed.
Test a read request first. Check the company and environment before enabling changes.

The API uses the portal’s business rules. An accepted request is not necessarily delivered or paid. Orders, payment requirements and monthly invoicing still apply.

API base URL

HTTPS API

https://my.binadit.com/api/v1

A company ID in a URL selects the company; it does not grant access. A connection only has its explicitly allowed actions and resources. Removing access blocks subsequent requests.

Endpoint reference