Aller au contenu principal

Les Thématiques

Une thématique, c'est quoi?​

Les thématiques vous permettent de catégoriser vos campagnes et/ou les liens de vos campagnes.

Elles sont comparables à des TAG : après avoir attribué une thématique à une campagne et/ou aux liens qu'elle contient, les actions effectuées sur cette campagne sont catégorisées comme étant des actions rattachées à ce TAG. Les thématiques vous permettent donc de cibler vos abonnés en fonction de leur activité (ouverture / clic) effectué sur une campagne rattachée à une thématique.

Il est possible de créer des sous thématiques enfants d'une thématique. Il est recommandé de ne pas dépasser 4 paliers.

Paramètres d’une thématique​

L'api utilise un objet de type Thematic pour faire des GET/POST/PUT.

Un objet Thematic possède les paramètres suivant:

  • idThematic : son identifiant
  • name :Le nom de la thématique (paramètre obligatoire à la création, maximum 50 caractères). Le nom doit être unique.
  • idParentThematic : l'ID de la thématique parent (0 si c'est une thématique principale, sinon l'id de la thématique parent)
  • isEnabled : indique si la thématique est active ou supprimée. True par défaut. si isEnabled = false, elle ne pourra pas être utilisée.
    Attention, tous les enfants d’une thématique hériteront de la modification de ce paramètre.

L'api Thematics​

Créer une thématique​

L'api permet de créer une thématique en faisant un appel POST /api/{idSite}/Thematics en fournissant un objet Thematic (sans id).

Exemple : Ici, on crée une nouvelle thématique principale

{ 
  "name": "Ma Thématique",
  "idParentThematic": 0,
  "isEnabled": true
}

Et nous créons ensuite une thématique enfant :

{
  "idParentThematic": 1,
  "name": "Ma sous Thématique",
  "isEnabled": true
}
Attention

Si le nom est déjà utilisé, la thématique ne sera pas créée et un contenu vide sera retourné.

Mettre à jour une thématique​

L'api permet de mettre à jour une thématique en faisant un appel PUT /api/{idSite}/Thematics

Exemple : Mettre à jour la thématique 141 avec un nouveau nom.

Attention!

Il est nécessaire de repasser l'objet complet pour mettre à jour tout ou partie des informations.

Exemple de modification de la thématique 141:

{
  "idThematic": 141,
  "idParentThematic": 1,
  "name": "Nouveau Nom Thématique",
  "isEnabled": true
}
info
  • Vous pouvez réactiver une thématique supprimée en repassant son paramètre isEnabled à true.
  • Si le nom est déjà utilisé par une autre thématique, une erreur sera retournée.

Supprimer une thématique​

Il est possible de supprimer une thématique, si celle-ci a des enfants, ces derniers seront également supprimés.

L'appel se fait en appellant DELETE /api/{idSite}/Thematics/{idThematic}

Exemple pour supprimer la thématique 141 sur la base de données 101 : DELETE https://api.mindbaz.com/api/101/Thematics/141

Consulter une ou toutes les thématiques​

L'api permet de consulter toutes les thématiques en faisant un appel GET /api/{idSite}/Thematics

Retour de la requête : 

{
  "data": [
    {
      "idThematic": 1,
      "idParentThematic": 0,
      "name": "Thématique",
      "description": "string",
      "isEnabled": true
    },
    {
      "idThematic": 2,
      "idParentThematic": 1,
      "name": "Sous Thématique",
      "description": "string",
      "isEnabled": true
    }
  ],
  "error": null,
  "success": true,
  "typeName": "Thematic[]"
}
Attention

Toutes les thématiques seront retournées (isEnabled true ou false)

L'api permet également de consulter une thématique en faisant un appel GET /api/{idSite}/Thematics/{idthematic}

Exemple : pour récupérer la thématique 141: https://api.mindbaz.com/api/101/Thematics/141

Retour de la requête :

{
  "data": [
    {
      "idThematic": 141,
      "idParentThematic": 0,
      "name": "Thématique 141",
      "description": "string",
      "isEnabled": true
    }
  ],
  "error": null,
  "success": true,
  "typeName": "Thematic"
}