Managely API Introduction and Necessary Tools

The Managely API is built upon well-established web standards and is straightforward to start using. Requests are issued using GraphQL queries and mutations, and responses are delivered in JSON. Authentication is handled using a simple OAUTH2 password flow. If you are unfamiliar with any of these technologies, you can learn more in the articles within this section. The help articles assume familiarity with these technologies.

GraphQL

https://graphql.org/learn/

JSON

https://www.w3schools.com/js/js_json_intro.asp

OAUTH2

https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2

Necessary Tools

As the API is built using a REST-based protocol, any tool that performs REST requests will work. However, some tools have GraphQL support built-in and make discovery easier. Managely has one of these tools built in, and you can access it directly in your web browser. This is the tool that used for the rest of these articles, but if you would like to consider an external tool, look at Insomnia (https://insomnia.rest/).

To integrate the API with your own code, any library that can make REST requests, along with a library that can handle OAUTH2 will work. For a GraphQL specific client library, Apollo (https://www.apollographql.com/apollo-client) is a popular choice.


Was this article helpful?
Thank you for your feedback!