Skip to content

Id mapping

ID Mapping allows you to define mappings between identifiers in different source systems and the master data.

This allows you to link data between different systems so that they can be correlated and shown in sensible way in Zoined Analytics Portal.

Operations

Upload list of identifier mappings

Request

POST https://api.zoined.com/idMapping?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
source_system_idstring

store (string, required) - Identifier in the source system

Example:"abc"
master_idstring

123 (string, required) - Identifier in master data

Example:"store"
entity_typestringrequired

Entity type this mapping is for (e.g. organisation, product)

Example:"organisation"
contextstringrequired

Type of data this mapping applies to

Example:"visitor"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/idMapping?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_system_id": "abc",
    "master_id": "store",
    "entity_type": "organisation",
    "context": "visitor",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}