How to generate a GraphQL Token for Xledger

GraphQL tokens are required to call the GraphQL API.

To generate a token please do the following:

1. Log into Xledger at https://www.xledger.net/. You must log in with a user that has the Administrator role.

2. Select the entity you wish to generate the token for.

3. Go to Administration → Access Control → GraphQL → API tokens

4. Click the Generate New Token button at the top of the screen.

5. Enter a meaningful token description e.g. “ConnectMyApps Token”

6. Select the scopes the token should have access to (see screenshot). Please check with your ConnectMyApps technical contact to confirm which scopes are relevant for your integration.
   Important! To validate the token, we check that we can query some customers using the token. Therefore, you must enable at least Read access to the “Customer” scope under Common, in addtion to any required scopes for your integration.

   Open

   

7. You will see a token on the screen, copy it. The token is sensitive and should be stored securely and never sent via email or other unsecured communication mechanism.

8. Log in to your ConnectMyApps Canvas account: https://canvas.connectmyapps.com/

9. Go to Applications, then click Add New Application.

10. Search for Xledger GraphQL and select it.

11. Enter your token from step 8 and select Live as environment.

12. Click Authenticate, you should see a green “success” message.

13. You will now be prompted to give your application a name. We recommend you put the Xledger entity code and environment in the name, to make it easy to recognise later. For example if your environment is live and code 99999 enter “99999 Live”.

14. Well done! You have successfully added Xledger GraphQL as an application.

Demo Environment:

The description above is for generating a token for the live environment. To generate a token for the demo environment the process is the same, but with the following differences:

Step 1: Log in to https://demo.xledger.net/.

Step 4: Go to https://demo.xledger.net/f/api-tokens.

Step 14: Set the name to be entity code plus “Demo”.

If you have any issues with the steps please contact support@connectmyapps.com