Creating an integration
Please follow these steps when creating a third-party integration with Infracost:
- User-specific API keys: ask your users to sign up for their own free Infracost API key and enter that into your product's settings page. This approach is used by our partners, including HashiCorp, as it enables users to use custom price books and other user-specific Infracost features. Your docs should mention something like:
- CLI JSON format: Infracost's CLI has a JSON format that you should use, e.g. get total cost estimate. We do not have language-specific clients so your application needs to run the Infracost CLI. You can also use this API if you have a Terraform plan JSON file already.
- Link to cost estimates: If you want to link to a cost estimate, use the share links feature to generate unique links such as this one. Your product integration can show a cost estimate summary and use share links for the full cost breakdown and diff. The Infracost JSON format has a
shareUrlkey with the link for that run.
- Email us: Our email is email@example.com, contact us if you need help or advice on the best ways to integrate, or would like to be featured in this page!