Les contacts

Les contacts sont des ensembles de données qui seront injectées dans le modèle de document pour le personnaliser. Chaque contact est un media d’une librairie de customization voir Customization.

Format d’un contact

 type TContact = { //media (contact)
  uuid: string;
  name: string;
  data: TChamps[]
};

Key	Description
uuid	Identifiant unique du contact, il doit être unique pour chaque contact.
name	Nom du contact, il sera affiché dans le panneau de formulaire.
data	Données du contact, il s’agit d’un tableau de champs.

Format d’un champ

 type TChamps = {
  key: TChampsKeys;
  value: string;
  param?: {}
};

Key	Description
key	Clé du champ, il doit être unique pour chaque champ.
value	Valeur du champ
param	Paramètres du champ, il s’agit d’un objet qui peut contenir des tags et un type.

Les champs disponibles

Format d’enregistrement des champs dans un contact. Seul les champs suivants sont disponibles pour la personnalisation des documents, les autres champs seront ignorés.

{
  key: 'KEY',
  value: 'VALUE'
}

Les champs sont des données qui seront injectées dans les variables du modèle de document pour le personnaliser. les champs disponibles sont les suivants :

FN : Nom complet

Le champ FN est un champ calculé qui contient le nom complet du contact. Nom formaté en Nom + Prénom

{
  key: 'FN',
  value: 'John Doe'
}

TITLE : Fonction

Le champ TITLE est la fonction du contact.

{
  key: 'TITLE',
  value: 'CEO'
}

FIRSTNAME : Prénom

Le champ FIRSTNAME est le prénom du contact.

{
  key: 'FIRSTNAME',
  value: 'John'
}

LASTNAME : Nom

Le champ LASTNAME est le nom du contact.

{
  key: 'LASTNAME',
  value: 'Doe'
}

NICKNAME : Surnom

Le champ NICKNAME est le surnom du contact.

{
  key: 'NICKNAME',
  value: 'Johnny'
}

N : Nom complet

Le champ N est un champ calculé qui contient le nom complet du contact. Nom formaté en Nom + Surnom + Prénom

{
  key: 'N',
  value: 'Doe Johnny John'
}

ROLE : Position hierarchique

Le champ ROLE est la position hierarchique du contact.

{
  key: 'ROLE',
  value: 'CEO'
}

CATEGORIES : Catégories

Le champ CATEGORIES est la catégorie du contact. Chaque catégorie est séparée par une virgule.

{
  key: 'CATEGORIES',
  value: 'Client, Partenaire'
}

ORG : Entreprise

Le champ ORG est le nom de l’organisation ou de l’entreprise du contact.

{
  key: 'ORG',
  value: 'Pixink'
}

BU : Business unit

Le champ BU est l’unité commerciale du contact.

{
  key: 'BU',
  value: 'Marketing'
}

KIND : Type de contact

Le champ KIND est le type de contact.

{
  key: 'KIND',
  value: 'individual'
}

Value	Description
individual	Individu
group	Groupe
organization	Organisation
location	Lieu
unknown	Inconnu

EMAIL : Email

Le champ EMAIL1 est l’email du contact.

{
  key: 'EMAIL1',
  value: 'someMail@example.com'
}

Key	Description
EMAIL1	Email du contact (type=internet) ex:personel
EMAIL2	Email du contact (type=internet) ex:compagny
EMAIL3	Email du contact (type=internet)
EMAIL4	Email du contact (type=internet)

TEL : Téléphone

Le champ TEL1 est le numéro de téléphone du contact.

{
  key: 'TEL1',
  value: '0123456789'
}

Key	Description
TEL1	Téléphone du contact (type=voice) ex: fixe
TEL2	Téléphone du contact (type=cell) ex: Mobile
TEL3	Téléphone du contact (type=work) ex: Bureau
TEL4	Téléphone du contact (type=voice)

URL : Site web

Le champ URL est le site web du contact.

{
  key: 'URL',
  value: 'https://www.pixink.io'
}

GEO : Geolocation

Le champ GEO est la géolocalisation du contact. Latitude et Longitude

{
  key: 'GEO',
  value: '48.8566, 2.3522'
}

GENDER : Genre

Le champ GENDER est le genre du contact.

{
  key: 'GENDER',
  value: 'M'
}

Value	Description
M	Homme
F	Femme
O	Autre
N	Pas applicable
U	Inconnu

BDAY : Date de naissance

Le champ BDAY est la date de naissance du contact. format attendu YYYYMMDD ou AAAAMMJJ

{
  key: 'BDAY',
  value: '19900101'
}

LOGO : Logo

Le champ LOGO est le logo de l’entreprise du contact. Url vers le logo de l’entreprise.

{
  key: 'LOGO',
  value: 'https://www.pixink.io/logo.png'
}

PHOTO : Photo

Le champ PHOTO est la photo du contact. Url vers la photo du contact.

{
  key: 'PHOTO',
  value: 'https://www.pixink.io/photo.png'
}

ADDR : Adresse

Le champ ADDRX_POSITION est un champ d’adresse du contact. Trois adresses sont disponibles pour chaque contact.

Key	Description
ADDR1	Adresse 1, (type=work) adresse du bureau
ADDR2	Adresse 2, (type=home) adresse du contact
ADDR3	Adresse 3, (type=intl) adresse internationnale de livraison

{
  key: 'ADDRX_POSITION',
  value: 'valeur du champ'
}

Key	Description
ADDR1_LINE1	Champ de l’adresse 1 pour la ligne 1
ADDR1_LINE2	Champ de l’adresse 1 pour la ligne 2
ADDR1_LINE3	Champ de l’adresse 1 pour la ligne 3
ADDR1_CP	Champ de l’adresse 1 pour le code postal
ADDR1_CITY	Champ de l’adresse 1 pour la ville
ADDR1_COUNTRY	Champ de l’adresse 1 pour le pays

CUSTOM : Champ personnalisé

Les champs CUSTOM sont des champs personnalisés du contact. 15 champs personnalisés sont disponibles pour chaque contact. CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5, CUSTOM6, CUSTOM7, CUSTOM8, CUSTOM9, CUSTOM10, CUSTOM11, CUSTOM12, CUSTOM13, CUSTOM14, CUSTOM15

{
  key: 'CUSTOMX',
  value: 'valeur du champ'
}

CALURI : URL du calendrier

Le champ CALURI est l’URL du calendrier du contact. Url vers le calendrier du contact.

{
  key: 'CALURI',
  value: 'https://www.pixink.io/calendar'
}

REV : Date de mise à jour

Le champ REV est la date de mise à jour du contact. format attendu YYYYMMDD ou AAAAMMJJ (Généré automatiquement par l’API, non modifiable)

{
  key: 'REV',
  value: '20240101'
}

LANG : Langue

Le champ LANG est la langue du contact.

{
  key: 'LANG',
  value: 'fr-FR'
}

KEY : Clé de chiffrement

Le champ KEY est la clé de chiffrement du contact.

{
  key: 'KEY',
  value: 'key'
}

TZ : Fuseau horaire

Le champ TZ est le fuseau horaire du contact. Fuseau horaire courant du contact. format: Continent/City

{
  key: 'TZ',
  value: 'Europe/Paris'
}

UID : Identifiant unique

Le champ UID est l’UUID du media du contact. (Généré automatiquement par l’API, non modifiable)

Ce champs permet de diffécier les contacts entre eux. exemple : homonyme

{
  key: 'UID',
  value: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}