Identifying unique users

In the Find API, the most common way to identify users uniquely is by providing them with a unique token obtained after logging in.

note

If you are currently authenticating with Partium by logging in and you don't share your login credentials amongst multiple users, you can ignore this article.

However, when integrating with Partium, there are specific cases where multiple users may share the same authentication key. This approach affects our Partium Analytics since we cannot distinguish between individual users.

To address this limitation, use the X-Partium-ExternalUserId header.

X-Partium-ExternalUserId header

The purpose of this optional header is to enable better usage analytics by uniquely identifying end users, even when they share the same authentication key.

The format of this header's value is open. Ensuring that the value is unique for each end user will guarantee that Partium Analytics can properly show their individual behavior and statistics.

Currently, the X-Partium-ExternalUserId header should be included only in the POST /search endpoint, as specified in the API reference.

HTTP

> POST https://api.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> X-Partium-ExternalUserId: 655f26ae-9abd-48da-abad-dfd026e92671
> Content-Type: application/json
> Content-Length: 354
>
> {
>   "language": "en",
>   "projection": [
>     "results.id",
>     "results.name"
>   ],
>   "matches": {
>     "organization": "<<Your Organization Name>>",
>     "text": "fan"
>   },
>   "resultOptions": {
>     "limit": 5
>   }
> }
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 284
<
< {
<   "sessionId": "0b61afea-1d06-496f-a0d9-cff254f45b41",
<   "imageId": null,
<   "results": [
<     {
<       "id": "RM5119150",
<       "name": "FAN"
<     },
<     {
<       "id": "RM5205317",
<       "name": "Fan"
<     },
<     {
<       "id": "RDC35320",
<       "name": "Fan A60D88F92"
<     },
<     {
<       "id": "RDC28113",
<       "name": "Fan wheel"
<     },
<     {
<       "id": "RM5159929",
<       "name": "Radial fan"
<     }
<   ],
<   "resultsTotalCount": 500
< }

Python

response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
    'X-Partium-ExternalUserId': '655f26ae-9abd-48da-abad-dfd026e92671'
  },
  json={
    'language': 'en',
    'projection': [
      'results.id',
      'results.name'
    ],
    'matches': {
      'organization': '<<Your Organization Name>>',
      'text': 'fan'
    },
    'resultOptions': {
      'limit': 5
    }
  },
)

JavaScript

fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
    'X-Partium-ExternalUserId': '655f26ae-9abd-48da-abad-dfd026e92671'
  },
  body: {
    language: 'en',
    projection: [
      'results.id',
      'results.name'
    ],
    matches: {
      organization: '<<Your Organization Name>>',
      text: 'fan'
    },
    resultOptions: {
      limit: 5
    }
  },
}).then(res => {
  ...
});