GraphQL API & Authentication

Describes how to authenticate to our GraphQL API.

What is GraphQL?

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

You can learn more about the GraphQL framework here: https://graphql.org/

For testing it would be good to use Postman or Insomnia or some other similar API client.

How do I access the TSG Global GraphQL API?

This authentication method is different than the API key authentication method used for other TSG Global services, and the TNID service.

You can generate a Bearer token to access our GraphQL API using the username and password you use to access our Customer Portal. This token lasts for 7 days.

Generate Bearer Token

POST https://api.portal.tsgglobal.world/account/login

Request Body

Name	Type	Description
email*	string	Your user email address.
password*	string	Your password.

200: OK

{
    "token": "POAPK_*********",
    "user": {
        "email": "[e-mail]",
        "first_name": "Test",
        "id": "*****",
        "last_name": "User",
        "level": "basic_user"
    }
}

401: Unauthorized Invalid email or password.

{
    "errors": [
        {
            "id": "unauthorized",
            "message": "Invalid email or password."
        }
    ]
}

When you query the API, you will want to pass your credentials in the header, with the header name "Authorization" and the value as "Bearer <token>".

If you are missing these credentials, please email us at: [e-mail]

Where can I test the GraphQL API and view more documentation?

You can test various features and view additional documentation in the GraphiQL interface we provide here: https://api.portal.tsgglobal.world/graphiql

What URL should I use to perform my queries and mutations?

Please use: https://api.portal.tsgglobal.world/graphql (note this is different than the GraphiQL UI).