Application Registration

Create a developer account

To begin building applications that integrate with our REST API, you first need to create a BigChange Developer Account. Navigate to the Account menu, where you can create new credentials by providing a username and password. Alternatively, you can simply sign in using your Google or GitHub account.

Initial Sign-up

After signing in for the first time, you'll be asked to provide additional information about your organisation. This provides us with some background on your specific integration use case, ensuring we can help you get the most out of our platform.

Initial submission

Following the creation of your account, you'll need to register a new application. Give the application a meaningful name and add information about its purpose and the permissions it requires. This step allows us to monitor API usage and ensures that any credentials provided to your application grant the minimal set of permissions needed to perform its function.

Once registered, the information you submit will be sent to the BigChange team for internal review. We'll approve and set up your application's access to our REST API. This process is usually fast but can sometimes take up to 72 hours.

Generate credentials

Upon approval, we'll notify you via the email address provided during registration. At this point, you gain the ability to generate credentials specific to your application and interact with the sandbox environment detailed in the email.

You can then use these credentials to interact with our REST endpoints, following the authentication guidance outlined in the REST documentation. Please ensure your application requested the necessary permissions to interact with the endpoints you intend to work with, otherwise you'll receive an authorization error.

Generating new credentials

Please note that creating new credentials for your application will deactivate any previously issued credentials and may cause your application to cease functioning.

Accessing customer data

Developing a new application using production customer data is discouraged. To safeguard the integrity of customer data, we'll provide details of the sandbox environment that you can use during the development phase. This allows you to rigorously test your application's functionality and ensure it meets your expectations before integrating with production customer data.

Once your integration is deemed ready for production deployment, let us know, and we'll facilitate the transition.