Skip to main content

Quick Start

Step 1: Explore the documentation​

  • Browse the API Reference for a broad overview on the style and function of the API
  • Familiarise yourself with the API Endpoints to understand the functionality that is currently offered
  • Take note of the rate and throttling limits called out in our usage policy

Step 2: Register your application​

  • Determine which API Endpoints your application requires and note down their scope requirement
  • Submit the details of your application, including an overview of it's purpose and your contact information
  • We'll review your application internally and let you know via email when approved

Step 3: Obtain credentials and authenticate​

Step 4: Make your first API request​

  • Choose an API endpoint you'd like to interact with and construct the request URL with any necessary query parameters
  • Set the Content-Type and Authorization required headers as described by the API Reference
  • Test your request by setting the Customer-Id header to the sandbox customer id you were provided in step 3

Step 5: Build and test your application​

  • Continue exploring our API Endpoints to build out your application's complete feature set
  • Be sure to use your sandbox customer id to safely build without impacting live production data during development phase
  • Once your application is complete and tested, let us know, and we'll create the necessary connections for production customer data

Step 6: Get support and stay up to date​

  • Connect with our developers in the BigChange Developer Discord if you have questions or issues to report
  • Streamline your build by sharing knowledge and ideas with other developers in our community

Congratulations! You're now on your way to leveraging the power of our REST API. Refer back to the documentation and this guide whenever you need assistance during your integration process. Happy coding!