GraphQL API
Last updated
Was this helpful?
Last updated
Was this helpful?
iAdvize GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.
One of the powers of GraphQL API is to allow you to retrieve many resources in one HTTP call and to request only the fields you need.
If you want to learn more about GraphQL in general, please check the official .
It's useful to note that the official documentation also lists a .
Our GraphQL API has a single endpoint: https://api.iadvize.com/graphql
The endpoint remains constant no matter what operation you perform.
If your environment is on the SD platform, your endpoint is: https://api.iadvize.com/graphql?platform=sd
The iAdvize GraphQL API is served over HTTPS.
Because GraphQL operations consist of potentially voluminous JSONs, we strongly recommend using our . But, you can also use cURL or any other HTTP-speaking library.
While with REST we use HTTP verbs to define the operations to perform, in GraphQL we will use the HTTP POST verb. This is because you must provide a JSON-encoded body whether you are performing a query or a mutation.
Here is an example to list all the routing rules :
The string value of "query" must escape quotes and backslash characters or the schema will not parse it correctly.
You can discover the schema and run queries on your iAdvize data using Apollo, an integrated development environment in your browser that includes the schema description, syntax highlighting, and validation errors.
If you want to know more about what can Apollo Explorer can do, you can checkout .