Skip to main content

Get token and use SoS API

🔐 How to get a token and call the API​

1. Login to the SoS Application​

Login using your email.

2. Open Account Settings​

Click your avatar in the top right corner to access account settings.

3. Create an API Key​

Go to the Integration tab and create your API key.

📡 How to Call the API Using the Token​

1. Add the API Key to Your Request Header​

Include the API key in the request header.

  • Your request must include the x-api-key header.

🧬 API Description​

1. Tools for GraphQL​

You can use any GraphQL client such as:

  • Apollo Sandbox
  • Apollo Developer Tools in SoS Nest

📎 GraphQL endpoint: /graphql

2. Understanding the GraphQL Response​

The response includes two types of fields:

  • Immutable fields: pid, address_one_line (cannot be changed)
  • Mutable fields (can be updated) follow this format:
columnName: {
  idColumn: "...",
  value: "..."
}

3. How to update value ?​

  • Use dataPoint mutation
  • Fill value of input:
  • entityId -> id of the record want update, value of (pid, sid, cid, ...)
  • idColumn -> value of idColumn recevied from above response
  • newValue -> new value for update