GraphQL API

About iAdvize GraphQL API

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 GraphQL documentation.

It's useful to note that the official documentation also lists a comprehensive list of clients and other tools here.

API Root Endpoint

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.

Building queries with GraphQL

Because GraphQL operations consist of potentially voluminous JSONs, we strongly recommend using our Apollo integration to create your GraphQL calls. 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 :

curl --request POST \
    --header 'content-type: application/json' \
    --header "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
    --url 'https://api.iadvize.com/graphql' \
    --data '{"query":"query {\n  routingRules {\n    id, name\n  }\n}","variables":{}}'

The string value of "query" must escape quotes and backslash characters or the schema will not parse it correctly.

Apollo

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.

Click here to use Apollo with our GraphQL api.

If you want to know more about what can Apollo Explorer can do, you can checkout their documentation here.