GraphQL Overview

You can use the Jungle GraphQL API to perform queries that you need to craft delightful integrations with us.

The Jungle GraphQL API has explicitly defined schema taking the guess work of allowed values, property names, client interoperability, and SDK generation.

Overview

Here are some quick links to get you up and running with the API:

• Authentication
• Endpoint

What is GraphQL

GraphQL is a query language for APIs. The query language is:

• A specification. The spec determines the validity of the schema on the API. The schema determines the validity of client calls.
• Typed. The API describes the allowed types and all relationships. Clients can only query for what is possible.
• Introspective. A client can query the API for details about the schema, types and relationships.
• Predictable. The GraphQL API's JSON response mirrors the shape of the query requested of it.

GraphQL Endpoint

The GraphQL API has a single endpoint:

https://ape.cafe/graphql

The endpoint remains constant no matter what operation you perform.

Authentication

The API has staged authentication. This means that certain operations, and introspection on the schema require no authentication.

Moving beyond that, you'll need to be authenticated as a known Jungle user to access your user profile, or have selected an account you have access to (via authAccountSwitch()).

Authentication can also be granted to machine actors via API keys.

Token

Used when a human being is interacting with the system, and has authenticated in a Jungle Application.

Currently this method of authentication is reserved for Jungle Applications.

API Key

Granted to known Jungle integrations, in context of a specific account when that account is connected to the integration.

API keys carry direct access to an account acting under a connection for known Jungle integrations, with a specific permission set (driven by integration needs).

See API Keys for clarification.

Reference

As GraphQL is introspective, you can self reference the schema to learn about the data types, queries, mutations and subscriptions available in the Jungle GraphQL API schema.

However, we provide the following hosted references:

1. Visually, in an interactive graph.
2. Along side the playground, in the docs tab.
3. Wrapped up in an SDK, for Node.js.
4. Reference documentation.

Further reading

Official documentation on GraphQL. https://graphql.org/learn

You can move on to getting started to learn more about the operations and examples with in the documentation.