Skip to main content

Setup Your Own API Interface Tool

Updated

Overview

This guide explains how to connect to your Administrate instance and run GraphQL queries using Altair.

Altair is a free GraphQL client, but you can use any IDE or API client that supports GraphQL requests.

Before you begin

You must obtain an access token before connecting to the API.

You will use this token when configuring your environment.

Install Altair

Configure your environment

After installing Altair, create an environment to store your instance URL and access token.

In the Environments panel, enter:

{
  "PORTAL_URL": "https://your-instance.administrateapp.com",
  "ACCESS_TOKEN": "your_access_token_here"
}

Replace the values with:

  • Your Administrate instance URL
  • Your OAuth access token

Connect to the GraphQL API

In Altair, configure your request:

  • Endpoint URL: https://api.getadministrate.com/graphql

Set your request headers:

Authorization: Bearer {{ ACCESS_TOKEN }}

This allows Altair to authenticate your requests using the environment variable.

Run queries and mutations

You can now enter GraphQL queries or mutations in the editor and execute them.

  • Write your query in the main editor
  • Click Send Request
  • Review the response in the results panel

Altair also provides schema exploration tools to help you build queries and understand available fields.

Next steps

Related articles