We've compiled a list of GraphQL resources that we use internally and find really valuable.

Table of content

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 has a great website which in itself is a great resource, but we especially love their Learn GraphQL introductory walkthrough.

Many of our employees in non-technical roles have been able to work through this tutorial and learn to use our API on their own!

What other Administrate-specific resources are available?

We've mentioned our Developer Portal a couple of times, but it's not just for documentation. Here, you can sign up for a free developer account and learn our API in a safe test environment.

How to Register on Our Developer Portal

1. Go to our Developer Portal here and click “Sign up”, or go directly to this page here to sign up,
2. Enter a unique email address,
3. Click “Create account” and we'll send you a link to verify your email address,
4. Check your mailbox and click the link in the email – check your spam folder if you can't find it,
5. Enter your name and choose a password, and click “Create account”.

How to link your developer account to a TMS instance

1. Make sure that you have a user account on that Administrate instance – not just the developer account you've just created – and that you know the email address and password to log in.
2. Log in to your developer account on the developer portal first.
3. Click the menu My Account in the top bar and select Profile. Alternatively, click here.
   
   
   
   
4. In the Instances section, click Link an instance.
   
   
   
   
5. Enter the URL of the Administrate instance you'd like to connect to, e.g., example.administrateapp.com, where example is your subdomain.
   
   
   
   
6. Enter your user's email address and password to log in to that instance.
   
   
   Note that, if you're already logged in to an Administrate instance, it will skip this step and offer you to connect to that instance. If you'd like to connect to another instance, cancel, log out of any Administrate instances you're currently logged in to, and start over.
   
   
7. Then click Allow access.
   
   
   
   
8. Once you've done this, any GraphQL queries that you run in the developer portal will run against that instance.