ChartMogul the platform
Currently, the ChartMogul platform offers a set of APIs for customers to integrate ChartMogul features and communicate with the platform:
Import API allows customers to push their billing data to ChartMogul from any billing system, and start analyzing their SaaS revenue.
Enrichment API lets you push additional customer metadata to ChartMogul, for use with Segmentation.
Metrics API gives you access to your SaaS metrics and analytics data – to put ChartMogul’s insights wherever is most valuable for your team.
These APIs act as building blocks for people to use in their apps, to build on top of and to generate new value from. We’re fully committed to making ChartMogul the central place to measure, analyze and grow your subscription business.
We want to make it as easy as possible for anyone to get started with integrating the ChartMogul platform, so we’re announcing a set of client libraries which do just that — starting today with a Ruby client.
The ChartMogul Ruby client
The Ruby client wraps up the complete functionality of all three ChartMogul APIs, giving you a single, abstracted way to interact with the ChartMogul platform. While you’ll always be able to communicate directly with each API, there are a number of benefits to using a client library:
- You don’t need to worry about handling raw API requests and responses.
- You can interact with ChartMogul using naming conventions that are on the same level as ChartMogul, i.e. Invoices, Plans, etc.
- You can get up and running much more quickly, and save developer time.
- The library will be maintained and updated to reflect new functionality as it’s launched.
The Ruby client library is fully open source. We’re encouraging the developer community to suggest improvements or raise issues, so that we can maintain the best possible implementation for you.
Getting started
Want to make use of the Ruby client library in your application? Great! To set up and install the library, check the GitHub project and its README.md:
Once set up, visit our Developer Hub where you can find a full endpoint reference for each API:
Then when you’re browsing the endpoint documentation for the API you wish to interact with, simply select and use the code examples under Ruby in your project:
Can you make a client library for [X]?
We’re currently working on a client library for Node.js, so if your app is running Node then stay tuned! After that, we have plans for more languages and frameworks. If you have something specific in mind, let us know via email so we can prioritize accordingly.