Welcome to the OnSign GraphQL API!
Here you'll be able to know more about using the OnSign GraphQL API. Before we jump in, here are some links to get started:
What is GraphQL?
GraphQL is a data query language with some specific capabilities:
-
A specification.
The spec determines the validity of the schema on our API servers. The schema determines the validity of your calls.
-
Strongly typed.
The schema defines an API's type system and all object relationships.
-
Introspective.
You can query the schema for details about the schema, generating docs and checking for updates and deprecations.
-
Hierarchical.
The shape of a GraphQL call mirrors the shape of the JSON data it returns.
Nested fields let you query for and receive only the data you specify in a single round trip.
-
An application layer.
GraphQL is not a storage model or a database query language.
The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects.
The API traverses and returns application data based on the schema definitions, independent of how the data is stored.
Why is OnSign using GraphQL?
The ability to define precisely the data you want – and only the data you want – is a powerful advantage over a traditional REST API.
GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify.
About the GraphQL schema reference
The docs in the explorer sidebar are generated from the GraphQL schema.
All calls are validated and executed against the schema.
Use these docs to find out what data you can call:
-
Allowed operations: queries and mutations.
-
Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects.
Note that you may need to rely on both the docs and the schema validation to successfully call the GraphQL API.
For other information, such as authentication and rate limit details, check out our guides in the sidebar.