navigation

Crunch Legacy API Documentation

Welcome to the Crunch legacy API documentation. This site will be available while our legacy API is still in its end of life phase. If you have an integration on the Crunch legacy API, please contact us about moving over to our new API

We are no longer authorising new integrations on our legacy API. For information on our new API see our new Developer Portal

The Crunch API

The Crunch application programming interface (API) has been introduced to allow potential developers the ability to integrate data and services from Crunch into third-party applications.

Our API has been developed in accordance with industry standard technologies and approaches so as to make its adoption and use as simple as possible. In order to utilise our API, developers will need at least a basic understanding of the following:

  • REST
  • XML
  • OAuth 1.0a

OAuth

All of our API endpoints are secured via OAuth 1.0, which means that no 3rd party can access our client’s data without permission, and that our clients are never required to enter their Crunch username & password into a 3rd party system. For more information on OAuth and Crunch please see the Authentication and OAuth page.

Documentation

The documentation available through our developer portal should give you everything you need in order to utilise the Crunch API.

  • The static documentation highlights the available endpoints and the possible structure of the XML/JSON payloads, to give developers an idea of what data they can extract and create.
  • The interactive documentation gives you the ability to try out the Crunch API as you would if it was real. The documentation lists all of the available endpoints, and allows you to push in data to Crunch and pull data out.