Skip to main content

OpenAPI: The Blueprint for RESTful APIs

OpenAPI is a specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services.

This industry-standard protocol offers a clear and well-structured format for API specifications, making it easier for developers to understand and integrate with APIs. At Zigned, we leverage OpenAPI to provide you with transparent and accessible API documentation. It ensures that you have all the necessary details at your fingertips for seamless integration with our services.


Download Our OpenAPI Specifications​

Get started with integrating our services into your workflow by downloading our OpenAPI specifications. These documents are your comprehensive guide to our API endpoints, parameters, and response formats.

  • Agreements, Files and Themes API Specification (YAML Format): Download YAML
  • Oauth2 Token Service API Specification (YAML Format): Download YAML

These specifications are regularly updated to reflect any changes or improvements in our API, ensuring you always have the latest information for a smooth integration process.


Generate a client library​

To get a head start you can generate a client library with tools such as openapi-generator. This will give you a ready-to-use client library in your preferred language.

Try it out at https://openapi-generator.tech

Keep in mind that some manual adjustments might be needed to fit your specific use, but generating a client is a great way to get started.

We're committed to making your development experience as efficient and straightforward as possible. With our OpenAPI specifications, you're well on your way to unlocking the full potential of Zigned's APIs.