Billit API for Developers

Start building an integration with Billit

 

Documentation New

Browse all the information you need to integrate with Billit: How do I get started with the API? How do I get started with the API key? How do I get started with OAuth?

More information

Library

Get familiar with our API. Here you will find sample code and SDKs in Swagger. Use your API token and simulate as much as you want.

More information

Code examples

Get familiar with our API. Here you will find sample code and SDKs in various programming languages.

More information

OAuth 2 is available

Give your users a simpler, faster, and more secure authentication experience, so you can focus on building smart solutions for your customers.

 

Find out what's new

 

Requirements for public integrations on Billit

The following requirements are used at Billit to review all public Integrations. These requirements are the same for both listed and unlisted Integrations. They're intended to provide the best experience across the entire Integration lifecycle, from branding, to installation, to onboarding, functionality, and quality. By following them, you can make sure that the review process is as quick as possible when you submit your own Integrations.

Billit Integration Review Flow

Is it working as expected on my.sandbox.billit.be?

 

 

Yes

 

Is it working as expected on my.billit.be?

 

 

Yes

 

Submit your app to appreview@billit.be, once approved marketing@billit.be will take over.

No

 

Reach out to support@billit.be with as much documentation as possible.

No

 

Reach out to support@billit.be with as much documentation as possible.

 

Caution

These requirements are subject to change, as we're continuously making improvements to the Billit Integrations Store and developer platform. Your Integration will be expected to meet any new requirements that are added here. The Billit Integration Review team can reject an Integration at their discretion if it doesn't meet the set standards.

1 Installation and setup

These requirements make sure that users can quickly set up and start using your Integration. The installation requirements describe the correct flows for authentication, Integration install charges, and any sign-up steps (if required). These requirements make sure that you provide users with the guidance they need when they start learning to use your Integration.

2 Functionality and Quality

For your Integration to be successful, it should offer a consistent and positive experience for the user who use it. The following functionality and quality requirements Integrationly to the core features of your Integration, such as its user interface, performance, and billing.

3 Integration Performance

For users to be successful, their integrations must have best-in-class speed and user experience. Integrations can easily slow down experiences, and we require Integrations to keep performance top-of-mind while helping users, to follow our performance requirements and best practices, and to test that their products continue to meet our minimum requirements for speed.

4 Integration Listing

The Integration listing is your calling card - it helps users find your Integration and understand how it can help them run their businesses. Your listing in Settings/Integrations explains the features, user interface, and functionality of your Integration. Your listing should clearly communicate functionality and pricing so that users can quickly understand the benefits of your integration.

5 Security and User Risk

Security is a critical part of any web-based business because integrations can be exposed or compromised in many different ways. Before you submit your integration, you need to make sure that it's secure so that the users who use it won't be at risk.

6 Data and User Privacy

Depending on the purpose of your integration, it might need to manage and store customer data. Make sure that your Integration meets the current best practices (and in some cases, the legal requirements) that protect customer data and user privacy.

7 Support

After you submit your integration, you need to support the users who use it. There are different ways to do this, such as answering user inquiries promptly and publishing detailed help documentation, or providing instructive in-Integration context and support so that users can quickly get the help they need when they use your Integration.

8 Testing your Integration before submitting

Before you submit your integration for review, you need to test it on a my.sandbox.billit.be to check for any bugs or errors. Many users depend on integrations, so it's important that you make sure your integration doesn't include any errors that could negatively impact users’ businesses. The Billit review team will only review production-ready Integrations. If you submit an Integration that is incomplete, is in beta, or has errors that prevent us from reviewing its features, then it will be rejected. After you've tested your Integration and made sure that it has met all of our Integration requirements, you can submit your Integration for Integrationroval. These instructions Integrationly to all Public Integrations, whether they are listed or unlisted in the Billit Integrations Store.

9 Installing an Integration on my.sandbox.billit.be

When a users installs your integration, it must first authenticate with the users’s company using APIKey or OAuth. The APIKey is available when a user clicks on the upper left white box and OAuth tokens can be asked via support@billit.be. You can test this by requesting OAuth tokens for your integration on my.sandbox.billit.be. If you don’t have a sandbox, then you can create one.

10 Installing an Integration on my.billit.be

When a users installs your integration, it must first authenticate with the users’s company using APIKey or OAuth. The APIKey is available when a user clicks on the upper left white box and OAuth tokens can be asked via support@billit.be. You can test this by requesting OAuth tokens for your integration on my.sandbox.billit.be. If you don’t have a sandbox, then you can create one.

11 Request Marketing collaboration with Billit Marketing to promote your integration to all users

Let's promote your new integration to as many users as possible! Reach out to marketing@billit.be to have your integration promoted in the platform, social media, newsletters, webinars...

12 Checklist

  The Integration is available on Settings/Integrations with a high quality logo, crystal clear descriptions in all supported languages.

  The More Information link redirects the user to a detailed help article with step by step guides or a recorded tutorial.

  The user is able to activate the Integration in a user friendly way with no help from support required.

  The user is able to reach out to your support agents if needed.

  The integration will be promoted via multiple marketing initiatives.