Skip to main content

Helpful GraphQL Resources

Updated

We’ve compiled a list of GraphQL resources that our team finds especially useful.

These resources are a good starting point whether you are new to GraphQL or looking for Administrate-specific developer guidance.

Table of contents

  1. What is GraphQL and how does it work?
  2. What other Administrate-specific resources are available? - How to register on our Developer Portal - How to link your developer account to a TMS instance

What is GraphQL and how does it work?

The GraphQL Foundation website is an excellent starting point. In particular, the Learn GraphQL section provides a clear introductory walkthrough.

Many team members in non-technical roles have successfully completed this tutorial and used it to begin working with our API.

What other Administrate-specific resources are available?

Our Developer Portal includes documentation, API tools, and access to a free developer account where you can experiment safely in a test environment.

It is not only for documentation. It is also the main place to explore and learn the Administrate API in a safe environment.

How to register on our Developer Portal

  1. Go to the Developer Portal and click Sign up, or go directly to the signup page.
  2. Enter a unique email address.
  3. Click Create account. You’ll receive an email to verify your address.
  4. Open the verification email and click the link (check your spam folder if needed).
  5. Enter your name, choose a password, and click Create account.

How to link your developer account to a TMS instance

  1. Ensure you have a user account on the Administrate instance you want to connect to, and that you know your login credentials.
  2. Log in to your developer account on the Developer Portal.

  3. Click Account in the top navigation bar, or go directly to your profile page.

  4. In the Instances section, click Link an instance. 

  5. Enter the URL of the Administrate instance you want to connect to (for example, example.administrateapp.com, where example is your subdomain). 

Enter instance URL 6. Enter your Administrate user email and password to log in. 

Instance login screen 
If you are already logged into an Administrate instance, the portal may automatically offer to connect to that instance. To link a different instance, log out first and restart the process. 7. Click Allow access. 

Allow access confirmation screen 8. Once linked, any GraphQL queries you run in the Developer Portal will execute against that connected instance.

You can also use the Core API playground without an account to query sample data. Try Me opens a guide’s example; press Run to execute it. When an instance is linked, the editor uses that instance and renews access through your developer session. Mutations change the connected instance’s data.

The public playground includes the AI assistant. Review generated operations before running them. Existing accounts, saved instance links and OAuth applications remain available at the new developer site.

Related articles