Gestion des champs

Gestion des champs pour la table des abonnées.

Il est possible de personnaliser les champs de votre base de données afin d'y intégrer vos propres données.

Nous vous mettons à disposition 2 types de champs :

Champs systèmes : ce sont les champs créés par défaut dans la base. Ils ne peuvent ni être modifiés ni supprimés.
Champs personnalisés : un quota de 50 champs personnalisés vous est attribué. Vous pouvez utiliser ces champs pour qualifier davantage la base ou les utiliser comme champs de topage.

Info

Pour augmenter le nombre de champs personnalisés, il suffit de contacter le Service Client ou de cliquer sur "Augmenter le quota" sur le site.

Vous trouverez plus d'information dans notre centre d'aide en cliquant ici.

Voir son quota

L'api permet de récupérer le nombre de champs personnalisés créés en faisant un appel GET sur le endpoint suivant /api/{idsite}/fields/quota

Exemple :

https://api.mindbaz.com/api/3/fields/quota

{
  "success": true,
  "data": {
    "quota": 190,
    "nbSpecificFields": 184,
    "nbRemainingFields": 6
  },
  "error": null,
  "typeName": "FieldsQuota"
}

Récupérer la liste des champs de la table des abonnés

Il est possible de récupérer via l'appel GET /api/{idsite}/fields/list?type={type} la liste des champs de la table contenant les abonnées. Vous obtiendrez en retour grâce à cette api la définition de tous les champs (nom, type, description) de la table.

Les paramètres à spécifier dans l'url sont les suivants :

Nom du paramètre	Valeur
type	Optionnel, type de champs à récupérer
idsite	Obligatoire, Identifiant de site MindBaz

Où le type correspond à:

Nom	Valeur	Description
Unspecified	0	Le type de champ n'est pas spécifié
Text	1	Le champ est de type texte
Integer	2	Le champ est de type nombre entier
Date	3	Le champ est de type date
List	4	Le champ est de type liste
Boolean	5	Le champ est de type booléen

Format de réponse:

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "length": 1,
      "list": [
        {
          "key": 64,
          "value": "sample string 2"
        },
        {
          "key": 64,
          "value": "sample string 2"
        }
      ],
      "fieldType": 0,
      "description": "sample string 3",
      "isSystem": true,
      "isVisible": true,
      "isEditable": true,
      "isHiddenByCustomer": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "length": 1,
      "list": [
        {
          "key": 64,
          "value": "sample string 2"
        },
        {
          "key": 64,
          "value": "sample string 2"
        }
      ],
      "fieldType": 0,
      "description": "sample string 3",
      "isSystem": true,
      "isVisible": true,
      "isEditable": true,
      "isHiddenByCustomer": true
    }
  ],
  "error": "sample string 2",
  "typeName": "sample string 3"
}

Les champs de l'objet Field retourné :

id : id du champ (utilisé dans les tags de personnalsation par ex [[FIELD.1]])
name : nom du champ
length : nombre de caractères pour un type "text"
list : tableau d'éléments {key(int),value(string)} pour un type "list"
fieldType : valeur (int) du paramètre d'entrée type.
isSystem : si le champ est un champ "systeme" c'est à dire créé par Mindbaz et identique pour tous les clients (id<100)
isVisible : si false, le champ n'est pas visible dans l'interface et n'est pas utilisé (utilisé lorsqu'on veut supprimer un champ) -champ réservé à Mindbaz
isEditable : si false, le champ ne peut pas être mappé dans un import de fichier
isHiddenByCustomer : si false, le champ sera caché dans l'interface mais toujour utilisable. Utile pour alléger l'interface des champs que vous n'utilisez plus ou qui n'ont pas besoin d'être affiché.

Récupérer les champs de la table des abonnés

L'appel GET api/{idsite}/Fields?idFields[0]={idFields[0]}&idFields[1]={idFields[1]} permet de récupérer les définitions des champs des abonnés en spécifiant en entrée la liste des id des champs souhaités. Il est possible de spécifier plusieurs identifiants dans les paramètres sous la forme ?idFields[0]={idFields[0]}&idFields[1]={idFields[1]:

Nom du paramètre	Valeur	Type
idFields	Obligatoire, Identifiants des champs à récupérer	Collection de nombre entier
idsite	Obligatoire, Identifiant de site MindBaz	Nombre entier

Exemple:

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "length": 1,
      "list": [
        {
          "key": 64,
          "value": "sample string 2"
        },
        {
          "key": 64,
          "value": "sample string 2"
        }
      ],
      "fieldType": 0,
      "description": "sample string 3",
      "isSystem": true,
      "isVisible": true,
      "isEditable": true,
      "isHiddenByCustomer": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "length": 1,
      "list": [
        {
          "key": 64,
          "value": "sample string 2"
        },
        {
          "key": 64,
          "value": "sample string 2"
        }
      ],
      "fieldType": 0,
      "description": "sample string 3",
      "isSystem": true,
      "isVisible": true,
      "isEditable": true,
      "isHiddenByCustomer": true
    }
  ],
  "error": "sample string 2",
  "typeName": "sample string 3"
}

Créer un champ dans la table des abonnés

Il est possible de créer de nouveaux champs dans la table des abonnés afin de pouvoir y stocker vos nouvelles valeurs. Toutefois, une fois créés, les champs ne peuvent être supprimés et le nombre de champs total est limité.

Requête POST api/{idsite}/Fields

Nom du paramètre	Valeur	Type
idsite	Obligatoire, Identifiant de site MindBaz	Nombre entier

Corps de la requête au format JSON :

Nom	Description	Type	Informations complémentaires
name	Nom du champ	Chaine de caractères	Obligatoire, 255 caractères max
description	Description du champ	Chaine de caractères	Aucune
fieldType	Type de champ (0:"Unspecified", 1:"Text", 2:"Integer", 3:"Date", 4:"List", 5:"Boolean")	EFieldType	Obligatoire
isHiddenByCustomer	Mettre true pour cacher le champ dans les interfaces de mindbaz email. Ce paramètre est modifiable dans la page de gestion des champs.	Booléen	False par défaut
length	Longueur du champ (nombre de caractères pour un champ texte, entre 1 et 6000)	Nombre entier	Obligatoire si le fieldType est Text
list	Valeurs autorisées si le champ est une liste de choix	Collection de FieldListTypeValue	Obligatoire si le fieldType est List

Exemple de valeur pour le champ list {0:non,1:oui} :

[
   {
     "key": 0,
     "value": "Non"
   },
   {
     "key": 1,
     "value": "Oui"
   }
 ]

Exemple de requête POST:

{
  "id": 1,
  "name": "sample string 2",
  "length": 1,
  "list": [
    {
      "key": 64,
      "value": "sample string 2"
    },
    {
      "key": 64,
      "value": "sample string 2"
    }
  ],
  "fieldType": 0,
  "description": "sample string 3",
  "isSystem": true,
  "isVisible": true,
  "isEditable": true,
  "isHiddenByCustomer": true
}

Retour

{
  "success": true,
  "data": {
    "id": 1,
    "name": "sample string 2",
    "length": 1,
    "list": [
      {
        "key": 64,
        "value": "sample string 2"
      },
      {
        "key": 64,
        "value": "sample string 2"
      }
    ],
    "fieldType": 0,
    "description": "sample string 3",
    "isSystem": true,
    "isVisible": true,
    "isEditable": true,
    "isHiddenByCustomer": true
  },
  "error": "sample string 2",
  "typeName": "sample string 3"
}

Modification d’un champ de la table des abonnés

Attention !

En cas de modification du type du champs, l'ensemble des valeurs pour ce champ seront purgées.

Vous devez passer l'objet Field au complet.

Requête PUT api/{idsite}/Fields

Nom du paramètre	Valeur	Type
idsite	Obligatoire, Identifiant de site MindBaz	Nombre entier

Corps de la requête au format JSON :

Nom	Description	Type	Informations complémentaires
id	Identifiant du champ, doit être >= 100	Nombre entier	Obligatoire
name	Nom du champ	Chaine de caractères	Obligatoire, 255 caractères max
description	Description du champ	Chaine de caractères	Aucune
fieldType	Type de champ (0:"Unspecified", 1:"Text", 2:"Integer", 3:"Date", 4:"List", 5:"Boolean")	EFieldType	Obligatoire
isHiddenByCustomer	Valeur indiquant si le champ a été caché par le client dans la page "gestion des champs" de Mindbaz	Booléen	Aucune
length	Longueur du champ (nombre de caractères pour un champ texte, entre 1 et 6000)	Nombre entier	Obligatoire si fieldType=Text
list	Valeurs autorisées si le champ est une liste de choix	Collection de FieldListTypeValue	Obligatoire si fieldType=List

Liste des champs systémes (non modifiable)

id_fld	Nom	nb carac	liste des valeurs	type	description
0	IdUser			Entier	identifiant unique de l'abonné
1	Adresse EMail	255		Texte	email de l'abonné : PAS DE DOUBLON POSSIBLE!
2	Date première inscription			Date	date de la 1ère inscription à la newsletter: non réinscriptible
3	Date dernière inscription			Date	date de la dernière inscription à la newsletter
4	Date désinscription			Date	date de la désinscription à la newsletter
5	Première provenance	50		Texte	nom de la 1ère provenance (associée à la 1ère inscription): non réinscriptible pour ne jamais perdre la 1ere provenance
6	Dernière provenance	50		Texte	nom de la dernière provenance (associée à la dernière inscription)
7	Etat de l'abonné		0:Abonné;1:Désabonné;2:Désabonnement manuel;3:Assainissement / Domaine invalide;4:Assainissement / Syntaxe invalide;5:Assainissement / Liste repoussoir;6:Assainissement / Doublon;7:Assainissement NPAI;8:En attente de confirmation d'inscription;9:Spam;10:En attente de validation;11:Test FAI;12:Désabonnement groupe	Liste	Interdiction d'envoyer sur des status différents de abonné
8	Optin Partenaire		0:non;1:oui	Liste	Inscription à l'optin partenaire
9	Désinscription Optin			Date	date de la désinscription optin partenaire
10	Inscription Optin			Date	date d'inscription optin partenaire
11	Enfants			Entier	nombre d'enfants
12	Date Naissance Dernier Enfant			Date
13	Civilité		0:Mr;1:Mme;2:Mlle	Liste	Le texte des valeurs peut être modifié sur demande
14	Nom	128		Texte
15	Prénom	128		Texte
16	Adresse	128		Texte
17	Ville	128		Texte
18	CP	20		Texte
19	Pays	50		Texte
20	Date de naissance			Date
21	Mode collecte 1ere prov		0:Achat;1:Echange;2:Naturel;3:Autre	Liste	Le mode de collecte de la 1ère provenance est normalisé pour faire des statistiques entre plusieurs bases. On peut donc facilement savoir si l'adresse a été achetée (0), échangée (1) ou recruté naturellement (2).
22	Type collecte 1ere prov		0:Site;1:Jeu;2:Coregistration;3:Viral;4:Form Externe;5:Autre	Liste	Le type de collecte de la 1ère provenance est normalisé pour faire des statistiques entre plusieurs bases. On peut donc facilement savoir si l'adresse provient d'un site (0), d'un jeu (1), de la coregistration (2), d'un mail viral (3) ou d'un formulaire externe (4).
23	Adresse RNVP 1	38		Texte	1er champ d'une adresse RNVP (Restructuration, Normalisation, Validation Postale) : Ligne Complément d'identification, d'identité ou de lieu (Appartement, Etage...)
24	Adresse RNVP 2	38		Texte	Ligne Complément d'identification du point géographique (Résidence, Bâtiment...)
25	Adresse RNVP 3	38		Texte	Ligne Numéro et libellé de la voie (volet distribution) (ex 10 rue de la Martingale)
26	Adresse RNVP 4	38		Texte	Ligne BP, TSA, Lieu-dit..
27	CP RNVP	5		Texte	Ligne Code Postal
28	Ville RNVP	38		Texte	Ligne Localité
29	Date Validation RNVP			Date	Date à laquelle les champs RNVP (23 à 28) ont été renseignés
30	Date Maj Adresse			Date	Date de mise à jour de l'adresse classique (champs 16, 17 et 18). Si la date de Maj > date validation RNVP, cela veut dire que l'adresse RNVP est périmée
31	Nhd_Reactivity			Entier	Réactivité dans le mois
32	Tracking Adresse IP	15		Texte	Dernière adresse IP trackée lors d'une ouverture
33	Tracking Navigateur	50		Texte	Nom du navigateur web détecté lors d'une ouverture
34	Tracking Sys Exploitation Fixe	50		Texte	Dernier système d'exploitation détecté lors d'une ouverture sur pc fixe
35	Tracking Sys Exploitation Mobile	50		Texte	Dernier système d'exploitation détecté lors d'une ouverture sur mobile
36	Tracking Modele Mobile	50		Texte	Dernier modèle de mobile tracké lors d'une ouverture
37	Webmail	50		Texte	Nom de domaine (ex: free.fr, yahoo.com, hotmail.com) extrait de l'email (maj la nuit)
38	Tel Fixe	25		Texte	Téléphone fixe
39	Tel Mobile	25		Texte	Téléphone mobile
40	Facebook ID	30		Texte	ID facebook
41	Referentiel INSEE		1:Quartier central hétérogène;2:Centre-ville dynamique;3:Quartier propriétaire aisé;4:Quartier très populaire familiale;5:Banlieue familiale très moyenne;6:Banlieue résidentielle très aisée;7:Banlieue pavillonnaire aisée;8:Quartier pavillonnaire chic;9:Quartier périurbain dynamique;10:Quartier périurbain résidentiel vieillissant ;11:Quartier pavillonnaire très aisé;12:Quartier périurbain résidentiel ouvrier ;13:Quartier rurbain moyen;14:Quartier rurbain résidentiel sénior;15:Quartier rurbain résidentiel et actif;16:Quartier rural moyen;17:Quartier rural ouvrier et familial;18:Quartier rural retraité;19:Village touristique retraité;20:Village familial moyen;21:Village ouvrier moyen;22:Village agricole vieillissant;23:Quartier chic parisien;24:Quartier parisien dynamique et actif;25:Quartier populaire parisien	Liste	Code INSEE
42	Referentiel CSP		0:CSP --;1:CSP -;2:CSP moyen;3: CSP +;4:CSP ++	Liste	Code CSP
43	id client	50		Texte
44	Date dernière ouverture			Date	Dernier date d'ouverture (utile pour faire des scenarii sur les inactifs)
46	Date dernier Clic			Date	Dernier dernier clic, hors lien miroir et désabo