Liste des méthodes

Wrapper

Les appels à l'API se font par cURL par le biais d'une classe PHP. Cliquez ici pour télécharger la classe Wrapper avec un exemple d'utilisation.

Pour utiliser le wrapper il suffit d'instancier la classe avec vos informations de connexions et ensuite d'appeler les méthodes voulues.

Exemple :

require_once 'Wrapper.class.php';

$wrapper = new Wrapper("http://s1.hpjcc.com/en/remote/", ' Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser. ', 'myHashedPassword');


$attributs = array('FirstName'=> 'Jules', 'LastName' => 'Verne');
 
$result = $wrapper->contactCreate(' Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser. ', $attributs);

Le constructeur possède trois arguments obligatoires :
- l'url de HPJCC, la plupart du temps http://s1.hpjcc.com/en/remote/
- votre nom d'usagé HPJCC
- votre mot de passe HPJCC chiffré à l'aide de md5 

Si l'instantiation s'est bien passée, l'attribut token de la classe wrapper devrait contenir une valeur.

 

Familles de méthodes

Les méthodes qui suivent sont regroupées par catégories, selon l'entité sur lesquelles elles agissent (infolettre, contact, campagne, etc). Ces méthodes sont appelées par cURL via le wrapper.


Infolettres

newslettersFind

Retourne les infolettres correspondant aux paramètres du filtre. Le filtre comprend les paramètres suivants : l'identifiant, le numéro d'identification, le sujet, la date de début, la date de fin, le statut et l'identifiant de la campagne.

Les dates doivent être passées sous forme de tableau tel que ci-dessous :

$date = array ('year' => 2013,  'month' => 4, 'day' => 18, 'hour' => 12, 'minute' => 3, 'second' => 10);

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newslettersFind'
newsletterId Identificateur de l'infolettre
identifier Numéro d'identification de l'infolettre
subject Sujet de l'infolettre
date_beginning Date de limite inférieure du filtre de recherche (comparé à la date de création de l'infolettre)
date_end Date de limite suppérieure du filtre de recherche (comparé à la date de création de l'infolettre)
status Statut de l'infolettre
campaign_id Identifiant de la campagne
local  'en' ou 'fr'

Valeur de retour
Tableau d'infolettres.
Chaque infolettre est un tableau avec les indices suivants : 'id', 'company_id', 'campaign_id', 'campaign_name', 'subject', 'content, 'last_update_mode', ''creation_date', 'update_date', 'status_name' et 'sending_date'.

newsletterGetInfo

Retourne les informations relatives à l'infolettre correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetInfo'
newsletterId Identificateur de l'infolettre
local  'en' ou 'fr'

Valeur de retour
Tableau avec les indices suivants : 'id', 'company_id', 'campaign_id', 'campaign_name', 'subject', 'creation_date', 'update_date', 'status_name' et 'sending_date'

Si l'infolettre est au statut 'Rejetée' la raison du rejet est à l'indice 'reason'.

newsletterGetContent

Retourne le contenu relatif à l'infolettre correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetContent'
newsletterId Identificateur de l'infolettre
local  'en' ou 'fr'

Valeur de retour
Tableau avec pour seul indice 'content'


newsletterGetStats

Retourne les statistiques relatives à l'infolettre correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetStats'
newsletterId Identificateur de l'infolettre
local 'en' ou 'fr'

Valeur de retour
Tableau avec les indices suivants : 'num_contacts', 'num_opened', 'num_bounced', 'num_unsubscribed' et 'num_spams'

newsletterGetStatus

Retourne le statut relatif à l'infolettre correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetStatus'
newsletterId Identificateur de l'infolettre
local 'en' ou 'fr'

Valeur de retour
Tableau avec pour seul indice 'status_name'.

Les différents statuts possibles sont : 'Nouvelle', 'Initialisée', 'Envoi en cours', 'Envoi programmé', 'En attente de validation', 'Validée', 'Rejetée' et 'Synchronisation'.

Si l'infolettre est au statut 'Rejetée' la raison du rejet est à l'indice 'reason'.


newsletterGet

Retourne les informations, le contenu et les statistiques relatives à l'infolettre correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGet'
newsletterId Identificateur de l'infolettre
local  'en' ou 'fr'

Valeur de retour
Tableau avec les indices suivants : 'id', 'company_id', 'campaign_id', 'campaign_name', 'subject', 'creation_date', 'update_date', 'status_name', 'sending_date', 'content', 'num_contacts', 'num_opened', 'num_bounced', 'num_usubscribed' et 'num_spams'

Si l'infolettre est au statut 'Rejetée' la raison du rejet est à l'indice 'reason'.

newsletterSave

Créé une infolettre ou fait une mise à jour d'une infolettre existante si l'identificateur existe.

La date d'envoi doit être passée sous forme de tableau tel que ci-dessous :

$sendingDate = array ('year' => 2013,  'month' => 4, 'day' => 18, 'hour' => 12, 'minute' => 3, 'second' => 10);

Les attributs permettent de modifier des mots clés dans le contenu de l'infolettre. Le attributs sont identifés par un nom se commençant et terminant par un '%'. Un exemple de tableau d'attributs à passer en paramètre à la méthode :

$attributs = array ( '%attribut1%' => 'Hello', '%attribut2%' => 'world');

Avec ces valeurs d'attributs l'infolettre suivante "%attribut1% %attribut2% !" est transformée en "Hello world !".

$social = array ( 'facebook' => true, 'twitter' => true, 'google' => false, 'linkedin' => false);

Avec ces valeurs l'infolettre aura les boutons de partage de Facebook et Twitter coché. Les boutons disponibles sont facebook, twitter, google et linkedin.


Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterSave'
campaignId Identificateur de la campagne
newsletterId Identificateur de l'infolettre
subject Sujet de l'infolettre
content Contenu de l'infolettre
sendingDate Date d'envoi programmée
attributs Attributs de modification du contenu
local 'en' ou 'fr'
social Sélectionner les boutons de partages sociaux

Valeur de retour
Si mise à jour infolettre : '1' si la mise à jour s'est bien passée

Si création d'infolettre : l'identificateur de l'infolettre créée

newsletterDelete

Supprime une infolettre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterDelete'
newsletterId Identficateur de l'infolettre
local  'en' ou 'fr'

Valeur de retour
'1' si la suppression s'est bien passée

newsletterSchedule

Modifie la date d'envoi programmée de l'infolettre.

La date d'envoi doit être passée sous forme de tableau tel que ci-dessous :

$sendingDate = array ('year' => 2013,  'month' => 4, 'day' => 18, 'hour' => 12, 'minute' => 3, 'second' => 10);

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterSchedule'
newsletterId Identificateur de l'infolettre
sendingDate Date d'envoi
local  'en' ou 'fr'

Valeur de retour
'1' si la mise à jour a fonctionné

newsletterSendToValidation

Envoie l'infolettre selectionnée en mode d'attente de validation.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterSendToValidation'
newsletterId Identficateur de l'infolettre
rappel Indique s'il s'agit d'un rappel ou non
local  'en' ou 'fr'

Valeur de retour
'1' si l'opération s'est bien déroulée

newsletterSend

Envoi l'infolettre séléctionnée.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterSend'
newsletterId Identficateur de l'infolettre
local  'en' ou 'fr'

Valeur de retour
Un tableau avec pour unique indexe 'ppointer'

newsletterSendTest

Envoi un test pour l'infolettre séléctionnée à l'adresse spécifiée.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterSendTest'
newsletterId Identficateur de l'infolettre
receiver Adresse courriel du destinataire
local  'en' ou 'fr'

newsletterGetNumberContactSendByDate

Retourne le nombre de contact ayant reçu une infolettre de la compagnie durant une période donnée.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetNumberContactSendByDate'
beginDate Début de la période
endingDate Fin de la période
status  50
local  'en' ou 'fr'

newsletterGetPreview

Retourne une prévisualisation de l'infolettre pour un contact donné

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Newsletter'
method 'newsletterGetPreview'
newsletterId Identficateur de l'infolettre
contactEmail Adresse courriel du destinataire à tester
local  'en' ou 'fr'

Valeur de retour
Le code html de l'infolettre


Campagnes

campaignCreate

Créé une campagne.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignCreate'
campaignName Nom de la campagne
sender_name Nom de l'expéditeur
sender_mail Adresse courriel de l'expediteur
template Gabarit de la campagne
description Description de la campagne
local  'en' ou 'fr'

Valeur de retour
Retourne l'identifiant de la nouvelle campagne si la création s'est bien déroulée.

campaignDuplicate

Duplique une campagne.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignDuplicate'
campaignId Identifiant de la campagne à dupliquer
local  'en' ou 'fr'

Valeur de retour
Retourne l'identifiant de la nouvelle campagne si la duplication s'est bien déroulée.

campaignsFind

Retourne les campagnes correspondantes au filtre. Les paramètres du filtre sont : le nom de la campagne, l'identifiant, le statut et le type.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignsFind'
campaignName Nom de la campagne
campaignId Identificateur de la campagne
campaignStatus Statut de la campagne : 'Active' ou 'Suspendue'
campaignType Type de la campagne : 'Standard' ou 'Opt-in'
local  'en' ou 'fr'

Valeur de retour
Tableau contenant une ou plusieurs campagnes.

Chaque campagne est un tableau contenant les indices suivants : 'id' et 'name'.

campaignGet

Retourne les informations relatives à la campagne correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignGet'
campaignId Identificateur de la campagne
local  'en' ou 'fr'

Valeur de retour
Tableau avec les indices suivants : 'id', 'company_id', 'name', 'template', 'creation_date', 'update_date', 'status', 'status_name' et 'filters'.

L'indice 'filters' contient entre zéro et plusieurs tableaux représentant les filtres de la campagne. Chaque filtre contient les indices suivants : 'id', 'filter_id' et 'filter_name'.

campaignGetContent

Retourne le contenu (template) relatif à la campagne correspondant à l'identifiant passé en paramètre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignGetContent'
campaignId Identificateur de la campagne
local  'en' ou 'fr'

Valeur de retour
Le template utilisé pour la campagne.

campaignSetContent

Met à jour le gabarit de la campagne.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignSetContent'
campaignId Identifiant de la campagne
campaignContent Contenu de la campagne
local  'en' ou 'fr'

Valeur de retour
Retourne 1 si la mise à jour s'est bien déroulée.

campaignUpdateFilter

Ajoute ou supprime un filtre à la cible de la campagne.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Campaign'
method 'campaignUpdateFilter'
campaignId Identifiant de la campagne
filterId Identifiant du filtre à ajouter ou supprimer
delete Pour supprimer ou ajouter le filtre (par défaut ajoute un filtre)
local  'en' ou 'fr'

Valeur de retour
Retourne 1 si on supprime un filtre avec succès.
Retourne un nombre si l'ajout s'est bien déroulé.


Contacts

contactsFind

Retourne les contacts trouvés en fonction des paramètres de recherche : nom de famille, courriel, désinscripton et rebond.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Contact'
method 'contactsFind'
name Nom de famille du contact
email Courriel du contact
unsubscribed Désincrit ou non
bounced Nombre de rebonds
local  'en' ou 'fr'

Valeur de retour
Tableau de contacts.

Chaque contact est un tableau avec pour indices : 'id', 'company_id', 'connector_key', 'creation_date', 'modification_date', 'deleted', 'unsubscribed', 'bounced', 'spam', 'optin_status' et 'attributs'.

Attributs est un tableau d'attributs. Les indices sont les noms des attributs.

contactCreate

Créé un contact ou met à jour un contact si celui-ci existe.

Par défaut créé un contact avec seulement une adresse courriel. Procéder comme suit pour les champs personnalisables :

$attributs = array('FirstName'=> 'Jules', 'LastName' => 'Verne);
$result = $wrapper->contactCreate(' Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser. ', $attributs);


Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Contact'
method 'contactCreate'
email Courriel du contact
attributs Tableau d'attributs
local  'en' ou 'fr'

Valeur de retour
Retourne true si aucune erreur.

contactGetProfileUrl

Retourne l'url du profil public du contact identifié par l'adresse email.


Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Contact'
method 'contactGetProfileUrl'
email Adresse email du contact
local  'en' ou 'fr'

Valeur de retour
Chaîne de caractère, URL du profile public.

Retourne une erreur 501 si le contact n'existe pas.


Attributs

keywordsFind

Retourne les attributs correspondant au filtre de recherche : nom et type.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Attribut'
method 'keywordsFind'
keywordName Nom de l'attribut
keywordType Type de l'attribut : '1' pour Text et '2' pour Email
local  'en' ou 'fr'

Valeur de retour
Tableau d'attributs.

Chaque attribut est un tableau avec les indices suivants : 'name', 'type', 'id' et 'search_string'

keywordGet

Retourne l'attribut correspondant au nom recherché.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Attribut'
method 'keywordGet'
keywordName Nom de l'attribut recherché
local  'en' ou 'fr'

Valeur de retour
Tableau avec les indices suivants : 'name', 'type', 'id' et 'search_string'


Tracker

trackerGetStats

Retourne pour une infolettre donnée, les trackers et les statistiques associées (nombre de clics).

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Tracker'
method 'trackerGetStats'
keywordName Identifiant de l'infolettre
local  'en' ou 'fr'

Valeur de retour
Tableau associatif contenant autant d'élément que de trackers. Chaque tracker contient les indides suivants : 'id', 'newsletter_id', 'url', 'num_contacts'


Filtre

filterCreate

Créé un filtre.

Paramètres
token Jeton fourni lors de l'authentification
class 'Hpjcc_Remote_Filter'
method 'filterCreate'
name Nom du filtre
attributId Identifiant de l'attribut sur lequel porte le filtre
operator Operateur du filtre (equal, contains, begin_comparator, different, not_null)
local  'en' ou 'fr'

Valeur de retour
Retourne l'identifiant du filtre créé.


Codes d'erreurs

Code Signification
Erreur Système
-100 Méthode inconnue
-101 La méthode ne peut être appelée
-102 Classe inconnue
-103 La classe ne peut être instantiée
-104 Timeout du serveur
-105 Jeton invalide
110 - Erreurs dues à l'utilisateur
110 Paramètre manquant
111 Jeton manquant
112 Paramètre représentant la classe anquant
113 Paramètre représentant la méthode manquant
114 Langue inconnue
116 Impossible de se connecter au compte
400 - Erreur Infolettre
400 Infolettre inconnue
401 Aucune infolettre trouvée
402 Infolettre désactivée
403 Impossible de créer l'infolettre
404 Impossible de mettre à jour l'infolettre
405 Impossible de supprimer l'infolettre
406 Erreur de paramètre
500 - Erreur Contact
500 Contact inconnue
501 Aucun contact trouvé
502 Contact désactivé
503 Impossible de créer le contact
504 Impossible de mettre à jour le contact
505 Impossible de supprimer le contact
506 Erreur de paramètre
700 - Erreur Attribut
700 Attribut inconnu
800 - Erreur Campagne
800 Campagne inconnue
801 Aucune campagne trouvée
802 Campagne desactivée
803 Impossible de créer la campagne
804 Impossible de mettre à jour la campagne
805 Impossible de supprimer la campagne
806 Erreur de paramètre
807 Statut de campagne inconnu
808 Type de campagne inconnu

Inscrivez-vous à notre infolettre

 

Connectez-vous avec nous