Should I use the GraphQL API or the SDK?
This guide is for developers deciding between using the GraphQL API or the SDK for integrating with Legalesign. It provides insights into the capabilities of each option and helps you choose the best approach for your project.
Advanced developers or developers with a currently no-SDK tech stack (such as .Net or GOLANG) have the choice of using the GraphQL or REST APIs directly. For many, the REST API is a tried and tested approach, however, our new GraphQL API has a far broader scope, everything that you can achieve in the Console web application can be automated and actioned with the GraphQL API. In fact, you can expand on what is presently in the Console and make dedicated, custom interfaces of your very own.
Using Both the GraphQL API and SDK
Yes. Very much, yes. If you have a Node or JavaScript compatible runtime then you can use the SDK to do most of the heavy lifting for you and only issue custom GraphQL calls when you need to. Why work harder than necessary?
Feature Comparison
| Feature | GraphQL API | SDK |
|---|---|---|
| Ease of Use | Requires knowledge of GraphQL queries | Simplifies common tasks |
| Flexibility | Full control over queries and mutations | Pre-built methods for common use cases |
| Compatibility | Works with any tech stack | Requires Node.js or JavaScript runtime |
Exploring the Schema
There are two main ways.
- Check out what the Console application shows you in its network requests and pick and choose what you want or,
- look through the queries and mutations available from the API in the GraphQL Explorer.
In summary, the GraphQL API is ideal for developers who need full control and flexibility, while the SDK is perfect for those looking for a quick and easy integration. If you're unsure, consider starting with the SDK and using the GraphQL API for advanced customizations.