Documentation Skalin

Champs personnalisés

Champs personnalisés

Ce document décrit l'utilisation des champs personnalisés avec l'APIs de Skalin.

Info

Des champs personnalisés peuvent être définis pour les objects Customer et Contact.

# Création de champs personnalisés

Les APIs de Skalin offrent un moyen de définir ses propres champs afin de pouvoir compléter la vision 360 avec vos données métiers.

Procédure de création de champ personnalisé :

  • Aller dans les Paramètres généraux "Settings > General"
  • Cliquez sur "Add field" dans la section Customer ou Contact suivant le besion.
  • Nommez votre champ personnalisé. Le nom pourra être modifié par la suite.
  • Sélectionnez le type du champ.
  • Enfin, cliquez sur "Create custom field".

Avertissement

Le type de champ personnalisé ne peut pas être modifié à postériori du fait de contraintes techniques sur les données déjà ingérées.

Création de champs personnalisés Skalin

# Alimentation des champs personnalisés via API

Les champs personnalisés sont de simples propriétés ajoutées aux objects Customer ou Contact. Il est nécessaire d'utiliser l'identifiant Skalin du champ personnalisé afin de le définir. Cet identifiant unique pour chacun de vos champs personnalisés est disponible dans la vue des champs personnalisés définis.

Identifiant de champs personnalisés Skalin

Exemple de création d'un customer avec un champ personnalisé

axios({
  method: 'POST',
  url: 'https://api.skalin.io/v1/customers?client_id={{ClientId}}',
  headers: {
    'Authorization: Bearer {{accessToken}}'
  },
  params: {
    refId: '{{refId}}',
    domain: '{{domain}}',
    name: '{{name}}',
    stage: '{{stage}}',
    a43eebc6971ace40: '{{Contenu champ custom d'id a43eebc6971ace40}}'
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# Type de données disponibles

Les champs personnalisés ont un type de donnée qui permet leur validation / affichage / modification au sein de la plateforme Skalin. Les types de données disponibles sont :

  • STRING : Chaine de caractères avec un maximum de 500 caractères
  • NUMBER : Nombre entier ou flottant
  • CURRENCY : Devise afficher avec la devise définie dans le paramétrage général
  • DATE : Date au format YYYY-MM-DD
  • DATETIME : Date avec heures et minutes au format UTC (YYYY-MM-DDTHH:mm:ss)
  • BOOLEAN : Booléen "true" ou "false" (false par défault)
  • PERCENT : Pourcentage, un nombre entier position entre 0 et 100
  • URL : Url commencant sur "http(s): //" avec une taille maximale de 500 caractères. Utilisez un raccourcisseur d'url au besion
  • USER : Identifiant Skalin d'un de vos utilisateur
Contributeurs: Julien