Skip to content

OpenAPI

Why does our API support OpenAPI, and why is it important for you?

  • Clear and Comprehensive Documentation: With OpenAPI, we provide you with a standardized and detailed description of our API. This ensures you have all the information you need to interact with our endpoints: parameter requirements, response formats, error codes, and more. No guessing, no confusion.

  • Interactive Tools at Your Disposal: Thanks to OpenAPI, you can use our API Reference or tools like Swagger UI or Postman to explore, understand, and test the API directly from the documentation. This makes it easier for you to experiment with requests and responses without writing a single line of code upfront.

  • Easier Integration with Your Applications: OpenAPI enables the generation of client libraries in various programming languages (e.g., Python, Java, JavaScript). To save you time, we already provide pre-built Client SDKs for the most popular languages, allowing you to start building your application right away without worrying about writing boilerplate code.
  • Smooth Workflow with Popular Tools: Many widely used tools and platforms, such as Postman or AWS API Gateway, natively support OpenAPI. You can import our OpenAPI specification file directly into these tools, simplifying the setup and integration process.
  • Faster Onboarding and Development: Whether you're a new developer or maintaining an existing integration, OpenAPI provides a "contract" for the API. You'll always have access to the latest, up-to-date details about how to interact with the API. This minimizes miscommunication and speeds up your development workflow.
  • Reliable Testing and Debugging: OpenAPI-compatible tools let you test requests and responses directly, helping you debug issues faster. You can also automate tests to ensure your application interacts with our API exactly as expected.

OpenAPI Resources

OpenAPI Specification

An OpenAPI specification file is a blueprint for your API, written in a machine-readable format (JSON). It acts as a contract between the API provider and its consumers, describing every aspect of how the API works. This includes:

  • Endpoints: The paths clients can call, and what those paths do.
  • HTTP Methods: Details on whether a request uses GET, POST, PUT, DELETE, etc.
  • Parameters: Input fields required or optional for each endpoint (e.g., query strings, headers, body data).
  • Responses: The structure of the data returned by the API, including status codes (e.g., 200, 404) and payload examples.
  • Authentication Requirements: How to authorize access, including headers, tokens, or API keys.

This file provides a single source of truth for the API’s behavior and capabilities, enabling both humans and machines to understand how to interact with it effectively. Our API Reference, as well as the SDKs are all built from the Invoicetronic OpenAPI Specification file.

API Reference

Our API Reference is the best resource for up-to-date information you need to interact with our endpoints: parameter requirements, response formats, error codes, and more. Also, it allows you to send test requests and obtain example code snippets for most languages.

References