We are thrilled to release our API V3
Our new Aligni API embraces GraphQL as the next step in the evolution of how Aligni integrations are built.
GraphQL is a query language for APIs and a runtime for executing those queries by using a type system defined with a schema. GraphQL allows clients to request exactly the data they need, and nothing more, making it efficient and flexible.
What Does This Mean for You?
This update will affect you if…
- You are currently leveraging the (now legacy) API V2; or
- You are currently working on development projects; or
- You are planning to build an integration using the Aligni API.
We highly recommend updating existing integrations to the new GraphQL API as soon as possible. GraphQL opens the doors for additional integration as well as simplified approach to queries with less work on both developers and servers.
We have created resources for developers and a sunset plan for the older version.
Introducing the GraphQL API Explorer
Aligni’s GraphQL API uses the GraphiQL (yep, there’s an extra “i” in there) tool to provide the reference documentation, API browsing, and real time query and mutation processing. It’s an excellent way to engage the API in our demo environment or in your production environment to test out queries and explore the API documentation.
Your organization’s GraphQL API Explorer URL is located here:
[your organizations url]/api/v3/graphiql
Don’t have an Aligni account? You can experiment with the live demo API here:
https://demo.aligni.org/api/v3/graphiql
Getting Started with the GraphQL API
How do you get started? Visit our documentation, of course! We’ve put together a few resources to help you get going quickly.
You can now access the GraphiQL API Explorer directly from the brand new Aligni system menu deployed earlier this week!
Legacy API Support
The legacy API (V2) enters maintenance support effective immediately. The API will be supported in maintenance mode until 2025-09-30.
Your integrations based on this API will continue to operate normally but we will no longer be making enhancements or improvements to this API. Critical bugs will continue to be fixed.