Public vs Private Integrations

Choose a private integration for one Bokio company, or a public integration for an application that multiple companies can use.

• Use a private integration for an integration that serves one company.
• Use a public integration for an integration that serves multiple companies, such as a CRM, commerce system, or integration platform.

Key differences

Private Integrations

Use a private integration to connect one company's internal systems or processes to Bokio. Create the integration in the Bokio app and authenticate requests with an Integration Token (a token that authorizes access to the company's data).

A company can create multiple private integrations and assign each integration only the permissions it needs. This helps limit access for company-specific workflows.

How Private Integrations Work in Bokio

Integration Token

Create a private integration in the Bokio app to generate its Integration Token. Use this token to authenticate API requests and authorize the application to access the company's data.

Custom Use Cases

Build private integrations for company-specific needs, such as automating data entry, synchronizing financial records with another system, or generating custom reports.

Example Workflow

1. Generate an Integration Token: Create a private integration in the Bokio app.
2. Configure authentication: Configure the integration to use its Integration Token.
3. Access company data: Use the token to make authenticated API requests to Bokio.

Public Integrations

Use a public integration for an application that multiple companies can connect to, such as a CRM, commerce system, or integration platform. Public integrations can access the General API and Company API, although some access may require additional permissions.

Register public integrations in the Developer Portal. See Create and edit an application in the Developer Portal.

Public integrations use OAuth 2.0 for authorization. Each API uses a different OAuth 2.0 grant:

• General API: Client credentials grant
• Company API: Authorization code grant

How Public Integrations Work in Bokio

Developer Portal

Register your application in the Bokio Developer Portal. Provide its name, description, and required permissions. For details, see Create and edit an application in the Developer Portal.

Security through OAuth

OAuth is a standard authorization protocol that lets third-party applications access data without receiving the user's Bokio credentials. When a user connects their Bokio account, Bokio asks them to sign in and authorize the application.

The OAuth flow has these steps:

1. Send an authorization request: Redirect the user to Bokio's authorization endpoint.
2. Request consent: The user signs in to Bokio and grants the application permission.
3. Receive an authorization code: Bokio redirects the user to your application with an authorization code.
4. Exchange the code: Your application sends the authorization code to Bokio's token endpoint and receives an access token.
5. Make authenticated requests: Use the access token to call Bokio APIs on the user's behalf.

No Limitation on Usage

After you register a public integration, multiple companies can connect their Bokio companies to your application.

Example Workflow

1. Register your application: Register the application in the Bokio Developer Portal and obtain its Client ID and Client Secret.
2. Request OAuth authorization: Redirect the user to Bokio's OAuth authorization URL. After the user signs in and grants permission, Bokio redirects them back to your application with an authorization code.
3. Exchange the authorization code: Send the code to Bokio's token endpoint to receive an access token.
4. Access data: Use the access token to make authenticated requests to Bokio's API on the user's behalf.

For details, see Getting started with Public Integrations.