Introduction

To query data using the NativeX GraphQL API, you must first login and obtain an authentication token. Each query to the API will verify your token and ensure that you have the required permission to access the data you request.

Logging In

To obtain an access token, use the loginUser GraphQL mutation:

Make sure you send your requests over HTTP/S!

While the NativeX API will enforce HTTP/S connections, you must ensure your username, password, and access tokens are not sent initially as plaintext over HTTP. Always verify you are using the https://... url to access the GraphQL API.

If you believe your account credentials have been compromised, please change your password within the Native-X interface immediately. For assistance contact [e-mail].

Query

mutation loginUser($input: LoginInput!) {
  loginUser(input: $input) {
    session {
      token
      exp
    }
  }
}

Variables

{
  "input": {
    "email": "[e-mail]",
    "password": "my_password"
  }
}

Response

{
  "data": {
    "loginUser": {
      "session": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI3OWYxNDAwOS1jZDlmLTU2ZDMtYmYyMi1lOGQyNWFlMDIyZDMiLCJleHAiOjE2NjczMjMxNjksImlhdCI6MTY2NzIzNjc2OX0.IxaANmlrDQY2BK1rbEoY-5ET_a9AxwyUJMHFkIVRWts",
        "exp": 1667323169
      }
    }
  }
}

This will return a JSON payload with your access token (data.loginUser.session.token), and the expiration date when your credentials will no longer be valid. The expiration date is a UNIX timestamp.

To access protected data using the API, you must include a valid access token with your request. Send this token as a Bearer-type Authorization header with any request that needs to be authenticated.

curl -X POST https://example.native-x.parameter1.com/graph \
  -H 'authorization: Bearer <mytoken>' \
  -H 'content-type: application/json' \
  -d '{"query":"query { allUsers { totalCount } }"}'
# Response: { "data": { "allUsers": { "totalCount": 17 } } }