• What integration options does the other system have? (API, import/export, webhooks, etc.)
• Is technical expertise available? (Internal development team or external consultant with API experience)
• What type of information should be exchanged? (e.g., documents, metadata, projects, users)

• How often should the information be synchronized? (Continuously, daily, manually)

• Is two-way integration needed? (Should both systems be able to read and write?)

• Which parts of the organization should the integration reach? (The whole organization or selected areas)

Documentation 

Our public API documentation is available at api-docs.ibinder.com. There you will find getting-started guides, authentication, a quickstart and a full endpoint reference.

Authentication and API clients

We use the OAuth 2.0 client credentials flow. Each API client belongs to one organization and authenticates with a client ID and client secret. API clients are an add-on: contact our support to have them enabled for your organization. Once enabled, organization owners manage everything themselves in iBinder, under API clients in the organization menu: create clients, choose each client’s role (Reader, Creator or Administrator), reset secrets and remove clients that are no longer in use.

Access scoped by area (Enterprise)

An API client does not have to reach the whole organization. On Enterprise, you can restrict a client to one or more areas and choose its role in each. You can add or remove areas later without creating a new client. This lets you test an integration on a single project or region, keep the impact low and open up more access when you are ready.

Presigned URL uploads

iBinder uses presigned URLs for file uploads. This means the client receives a temporary link with access rights and can upload files directly to storage without going through the API. This provides efficient and secure uploading, governed by Azure Blob Storage limitations.

Request and response format

Only JSON is supported for request and response data.

API versioning and backward compatibility

The iBinder API is currently at version 1.0. To ensure backward compatibility and allow changes without breaking existing integrations, versioning is used. Version 1.0 has no version indicator in the URL (base URL: https://api.ibinder.com/api). Future versions will have version numbers in the URL, e.g., https://api.ibinder.com/api/v2.

iBinder aims to avoid breaking changes and instead prefers incremental additions. When changes are needed, advance notice is provided, and customers are given time to update their integrations. Each version is supported for at least 12 months after a new version is released.

API call limitations (Rate limiting)

To prevent abuse and ensure fair usage, rate limiting and throttling are applied. Limits vary depending on client type and request. If limits are exceeded, a “429 Too Many Requests” response is returned.

Documentation and testing

Everything you need to get started is in our public documentation at api-docs.ibinder.com, including a ready-made Postman collection for testing. Feel free to contact us if you have any questions.