Sommaire | ||
---|---|---|
|
...
Authentification
Les paramètres d’authentifications d’authentification doivent être fournis pour chaque appel à l’API.
Paramètres
Nom | Description |
---|---|
method | La méthode de l'API que vous voulez appeler |
apikey | Votre clé d'API |
username | Votre nom d'usager (le même que pour votre login a PUBLITRAC*) *Notez que nous pouvons vous créer un usager pour l'usage de l'API seulement |
mot de passe | Votre mot de passe (le même que pour votre login a PUBLITRAC) |
Syntaxe
https://app.publitrac.com/api?method=[Nom de méthode]&apikey=[Votre clé API]&username=[Votre usager]&password=[Votre mot de passe]
Exemples
https://app.publitrac.com/api?method=getLeads&apikey=1234e567-890c-123e-4567-8901b234c56&username=MyUser&password=MyPassw0rd
Clé d'API
Votre clé d'API se trouve dans la section configuration dans l'onglet "Information du compte"
Limitation
Les appels à l’API doivent être limités à 50 par seconde.
Champ du lead
Pour connaitre les champs du lead, veuillez consulter la le Lexique et champs natifs (disponibles par défaut).
Format
Toutes les dates envoyées avec l’API de PUBLITRAC doivent être du format « yyyy-mm-dd ».
Si le champ doit aussi comprendre le temps, le format devra être « yyyy-mm-dd hh:mm:ss ». Exemple : 2014-01-28 02:04:01.
Structure XML
Les paramètres de la requête doivent être codés correctement sinon ils seront rejeté rejetés par l'API
Afin de vous assurer que les paramètres XML de la requête sont codés correctement, il est recommandé de valider à l’aide d’un outil tel que : http://www.w3schools.com/xml/xml_validator.asp
Index des méthodes
Get leads
Effectuer une recherche de leads.
URL | https://app.publitrac.com/api |
Supporte | GET |
Méthode | getLeads |
Paramètres obligatoires | method : getLeads apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe query : La représentation de votre requête de recherche. |
Paramètres facultatifs | page : Page id (defaut est 1) |
Remarques | Les champs personnalisés sont affichés comme des champs leads réguliers. La représentation d’une requête XML est décrite à la fin de ce document. |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <request> <queries> <query> <field>firstName</field> <operator>like</operator> <value>john</value> </query> <query> <field>lastName</field> <operator>like</operator> <value>smith</value> </query> <query> <field>email</field> <operator>like</operator> <value>johnsmith@%</value> </query> </queries> </request> |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <leads> <lead> <id>470</id> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>PUBLIPAGE</company> <phone>555-555-2149</phone> <email>johnsmith@publipage.com</email> <mailingAddress></mailingAddress> <originalSource>Google</originalSource> <originalSourceType>Organic Search</originalSourceType> <keyword>marketing automation</keyword> <jobTitle></jobTitle> <dateOfBirth></dateOfBirth> <status>Active</status> <score>0</score> <postalCode></postalCode> <country></country> <city></city> <state></state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <token>_nl-publipage.com-1282527313351-84730</token> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <fax></fax> <mobile></mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes></notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId></customerId> <website></website> <language></language> <nbrEmployees></nbrEmployees> <revenue></revenue> <crmLeadId>5564344</crmLeadId> <createdDate>2015-08-23 01:35:13</createdDate> <lastUpdated>2015-10-25 02:20:06</lastUpdated> <someCustomField>my custom field</someCustomField> </lead> </leads> <paging> <page>1</page> <items>1</items> <offset>100</offset> <total>1</total> </paging> <status>2001</status> <message>Get leads success.</message> </response> |
Info | |||||
---|---|---|---|---|---|
Une recherche sur tous les leads peut être appliquée avec une requête vide, voir exemple ci-dessous:
|
...
Get lead
Rechercher un lead par son courriel
URL | https://app.publitrac.com/api |
Supporte | GET |
Méthode | getLead |
Paramètres obligatoires | method : getLead apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe email : L’adresse courriel du lead. |
Paramètres facultatifs | |
Remarks | Si vous ne possédez pas l’adresse courriel, utilisez la méthode getLeads afin d’effectuer une recherche pour le lead désiré. |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
https://app.publitrac.com/api?method=getLead&apiKey=myApiKey&username=john&password=pass&email=johnsmith@publitrac.com |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <leads> <lead> <id>26005</id> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>PUBLITRAC</company> <phone>514-555-2149</phone> <email>johnsmith@publitrac.com</email> <mailingAddress>123 Street</mailingAddress> <originalSource>New Lead</originalSource> <originalSourceType>Manual</originalSourceType> <keyword>Marketing Automation Solution</keyword> <jobTitle></jobTitle> <dateOfBirth></dateOfBirth> <status>Active</status> <score>0</score> <postalCode>J4W 1Z1</postalCode> <country>Canada</country> <city>Montreal</city> <state>Quebec</state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <token></token> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <fax></fax> <mobile></mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes></notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId></customerId> <website></website> <language></language> <nbrEmployees></nbrEmployees> <revenue></revenue> <crmLeadId></crmLeadId> <createdDate>2010-06-04 15:58:37</createdDate> <lastUpdated>2010-06-04 15:58:37</lastUpdated> <someCustomField>custom value</someCustomField> </lead> </leads> <status>2002</status> <message>Get lead success.</message> </response> |
Get lead by external id
Rechercher un lead par son external id
URL | |
Supporte | GET |
Méthode | getLeadByExternalId |
Paramètres obligatoires | method : getLeadByExternalId apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe externalId: L’external id du lead. |
Paramètres facultatifs |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
https://app.publitrac.com/api?method=getLeadByExternalId&apiKey=myApiKey&username=john&password=pass&externalId=123ABC |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <leads> <lead> <id>26005</id> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>PUBLITRAC</company> <phone>514-555-2149</phone> <email>johnsmith@publitrac.com</email> <mailingAddress>123 Street</mailingAddress> <originalSource>New Lead</originalSource> <originalSourceType>Manual</originalSourceType> <keyword>Marketing Automation Solution</keyword> <jobTitle></jobTitle> <dateOfBirth></dateOfBirth> <status>Active</status> <score>0</score> <postalCode>J4W 1Z1</postalCode> <country>Canada</country> <city>Montreal</city> <state>Quebec</state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <token></token> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <fax></fax> <mobile></mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes></notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId></customerId> <website></website> <language></language> <nbrEmployees></nbrEmployees> <revenue></revenue> <crmLeadId></crmLeadId> <createdDate>2010-06-04 15:58:37</createdDate> <lastUpdated>2010-06-04 15:58:37</lastUpdated> <someCustomField>custom value</someCustomField> </lead> </leads> <status>2010</status> <message>getLeadByExternalId success.</message> </response> |
Sync Lead
Synchroniser un lead, si un lead eexiste existe par courriel (aucun doublon), une mise à jour sera effectuée).
URL | https://app.publitrac.com/api |
Supporte | POST |
Méthode | syncLead |
Paramètres obligatoires | method : syncLead apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe query : La représentation XML du lead à insérer ou à mettre à jour. |
Remarques | Cette méthode ajoutera un nouveau lead si aucun leads lead n'est trouvé dans la base de données via la clé d'unicité défini. Voici la liste des clés d'unicitées unicités possibles :
Il est aussi possible de fusionner ou d'ignorer les leads anonymes. Par exemple, si vous faite faites la synchronisation de vos leads d'une page web et que vous désirer désirez fusionner les intérations interactions que le visiteur a fait faites sur votre site web avant son acquisition . au profile creerprofil créé. Dans ce cas vous devez utilisé utiliser mergeAnonymous à 1 (vraievrai) useToken à 0 (faux) in the API calldans l'appel à l'API. Si les informaitons informations mergeAnonymous ou useToken ne sont pas définidéfinies, la valeur par defaut défaut sera mis mise à 0 (faux). Faire attention aux erreurs les plus fréquentes :
|
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <request> <useToken>true</useToken> <lead> <token>_nl-yourdomain.com-1323891914130-53205</token> <crmLeadId>CRM_ID134</crmLeadId> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>ACME</company> <phone>555-423-2453</phone> <email>johnsmith@mydomain.com</email> <mailingAddress>134 Ocean Street</mailingAddress> <leadSource>New Production ABC</leadSource> <originalSource> New Production ABC</originalSource> <originalSourceType>Organic</originalSourceType> <jobTitle>Software Engineer</jobTitle> <score>90</score> <postalCode>90211</postalCode> <country>USA</country> <city>Compton</city> <state>CA</state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <unsubscribeReason></unsubscribeReason> <fax>555-324-2134</fax> <mobile>555-432-1242</mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes>This lead is very interest in product ABC</notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId>123</customerId> <website>http://www.acme.com</website> <language>fr</language> <nbrEmployees>4</nbrEmployees> <revenue>400000</revenue> <customFields> <carColor>Red</carColor> <carMaker>Infiniti</carMaker> </customFields> </lead> </request> |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <status>2006</status> <message>Leads synchronization successfull.</message> </response> |
...
Get View
Récupérer les leads qui font partie d’une liste filtrée.
URL | https://app.publitrac.com/api |
Supporte | GET |
Méthode | getView |
Paramètres obligatoires | method : ‘getView’ apiKey : Votre clef API username : Votre nom d’usager password password: Votre mot de passe viewName: Le nom de la liste filtrée. |
Paramètres facultatifs | page: Identifiant de page (défaut = 1) |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
https://app.publitrac.com/api?method=getView&apiKey=abc&username=john&password=pass&viewName=PromoABC_Email_Open&page=1 |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <leads> <lead> <id>470</id> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>PUBLIPAGE</company> <phone>514-555-2149</phone> <email>johnsmith@publipage.com</email> <mailingAddress></mailingAddress> <originalSource>Google</originalSource> <originalSourceType>Organic Search</originalSourceType> <keyword>marketing automation</keyword> <jobTitle></jobTitle> <dateOfBirth></dateOfBirth> <status>Active</status> <score>0</score> <postalCode></postalCode> <country></country> <city></city> <state></state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <token>_nl-publipage.com-1282527313351-84730</token> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <fax></fax> <mobile></mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes></notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId></customerId> <website></website> <language></language> <nbrEmployees></nbrEmployees> <revenue></revenue> <crmLeadId>5e0ff332-090c-b97d-6325-4c786a68e9a7</crmLeadId> <createdDate>2010-08-23 01:35:13</createdDate> <lastUpdated>2010-10-25 02:20:06</lastUpdated> <someCustomField>my custom field</someCustomField> </lead> </leads> <paging> <page>1</page> <items>1</items> <offset>100</offset> <total>1</total> </paging> <status>2001</status> <message>Get leads success.</message> </response> |
Get List
Récupérer les leads qui font partie d’une liste.
URL | https://app.publitrac.com/api |
Supporte | GET |
Méthode | getList |
Paramètres obligatoires | method : getList apiKey : Votre clef API username : Votre nom d’usager password: Votre mot de passe listName: Le nom de la liste filtrée. |
Paramètres facultatifs | page: Identifiant de page (défaut = 1) |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
https://app.publitrac.com/api?method=getList&apiKey=abc&username=john&password=pass&viewName=Imported2012&page=1 |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <leads> <lead> <id>470</id> <firstName>John</firstName> <lastName>Smith</lastName> <middleName></middleName> <company>PUBLIPAGE</company> <phone>514-555-2149</phone> <email>johnsmith@publipage.com</email> <mailingAddress></mailingAddress> <originalSource>Google</originalSource> <originalSourceType>Organic Search</originalSourceType> <keyword>marketing automation</keyword> <jobTitle></jobTitle> <dateOfBirth></dateOfBirth> <status>Active</status> <score>0</score> <postalCode></postalCode> <country></country> <city></city> <state></state> <doNotCall>0</doNotCall> <doNotCallReason></doNotCallReason> <token>_nl-publipage.com-1282527313351-84730</token> <unsubscribed>0</unsubscribed> <unsubscribeCause></unsubscribeCause> <fax></fax> <mobile></mobile> <isCustomer>0</isCustomer> <isAnonymous>0</isAnonymous> <emailInvalid>0</emailInvalid> <emailInvalidCause></emailInvalidCause> <notes></notes> <suspended>0</suspended> <suspendedReason></suspendedReason> <blacklisted>0</blacklisted> <blacklistedCause></blacklistedCause> <customerId></customerId> <website></website> <language></language> <nbrEmployees></nbrEmployees> <revenue></revenue> <crmLeadId>5e0ff332-090c-b97d-6325-4c786a68e9a7</crmLeadId> <createdDate>2010-08-23 01:35:13</createdDate> <lastUpdated>2010-10-25 02:20:06</lastUpdated> <someCustomField>my custom field</someCustomField> </lead> </leads> <paging> <page>1</page> <items>1</items> <offset>100</offset> <total>1</total> </paging> <status>2001</status> <message>Get list success.</message> |
...
Add leads to list
Ajouter un lead à une liste statique (non filtrée) et créer la liste si elle n'existe pas.
URL | https://app.publitrac.com/api |
Supporte | POST |
Méthode | addLeadsToList |
Paramètres obligatoires | method : addLeadsToList apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe query: La représentation XML d’une association entre un lead et une liste. |
Paramètres facultatifs | |
Remarques | Le nom de la liste doit contenir moins de 50 caractères. |
Exemples
Info |
---|
Le XML ci-dessous peut contenir plusieurs adresses courriel de leads existants et une seule liste. Les leads seront automatiquement associés à la liste statique. |
...
Add web visit history
Ajouter une visite web à l'historique d'un lead existant.
URL | https://app.publitrac.com/api |
Supporte | POST |
Méthode | addWebVisitHistory |
Paramètres obligatoires | method : addWebVisitHistory apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe email: L’adresse courriel du lead. query: L’information de la visite. |
Paramètres facultatifs | |
Remarques | Le courriel du lead doit contenir moins de 50 caractères. |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <request> <webvisitleadhistory> <information>/blog</information> <context>Blog viewed</context> <url>http://www.acme.com/blog</url> <query>blog_post=product_abc_launch</query> <referral>http://www.linkedin.com/home.php?udi=1</referral> <ip>71.23.75.32</ip> <userAgent>Mozilla/5.0 (Windows; U; Windows NT 6.1; es-ES; rv:1.9.1.16) Gecko/20101130 Firefox/3.5.16</userAgent> <sessionId>2192c0f3802f8e0744e9940788121624</sessionId> </webvisitleadhistory> </request> |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <status>3002</status> <message>Add web page history success.</message> </response> |
...
Insère un ou plusieurs leads dans une campagne automatisé automatisée existante.
URL | https://app.publitrac.com/api |
Supporte | POST |
Méthode | executeCampaign |
Paramètres obligatoires | method : executeCampaign apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe query: La représentation XML d’un lead et de plusieurs campagnes à associer. |
Paramètres facultatifs | |
Remarques | L’objet de requête peut contenir plusieurs courriels et plusieurs campagnes. Si plusieurs leads avec la même adresse courriel existent, seulement la première occurrence du courriel sera traitée. À noter tout tous les leads spécifiés seront assigné assignés à la campagne définidéfinie, si un lead ou une des campagnes spécifiés n'existe pas dans votre compte, rien ne sera traité. |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <request> <leads> <lead> <email>test@exemple.com</email> </lead> <lead> <email>johnsmith@acme.com</email> </lead> </leads> <campaigns> <campaign> <name>Trade Show May</name> </campaign> </campaigns> </request> |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <status>1100</status> <message>Execute campaigns on leads success.</message> </response> |
Add emails campaign
Exécuter une campagne de marketing par courriel sur un ou des leads.
Cette méthode va automatiquement créer un courriel, une liste et une campagne. Les leads seront ajoutés à la campagne et ils recevront le courriel. Si la campagne existe déjà, il va réutiliser cette dernière et y ajouter les nouveaux leads.
URL | https://app.publitrac.com/api |
Supporte | GET/POST |
Méthode | addEmailCampaign |
Paramètres obligatoires | method : addEmailCampaign apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe query: La représentation XML du courriel et des leads. |
Paramètres facultatifs | |
Remarques | Un maximum de 50 leads peut être exécuté par appel. |
Le nom de la campagne doit contenir moins de 50 caractères |
Exemples
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <request> <information> <name>Promotion January 2014</name> </information> <email> <fromName>PUBLITRAC</fromName> <fromEmail>no-reply@publipage.com</fromEmail> <subject>January Promotion</subject> <message> <html> <![CDATA[ <html><body> Hello <strong>{{FirstName;Default=}}</strong>.<br /><br /> There is a new promotion this year…<br /><br /><br /></body></html> ]]> </html> <text> <![CDATA[ Hello {{FirstName;Default=}}. There is a new promotion this year… ]]> </text> </message> <options> <sendAsSalesRep>false</sendAsSalesRep> </options> </email> <leads> <lead> <firstName>John</firstName> <lastName>Smith</lastName> <company>ACME</company> <phone>555-423-2453</phone> <email>jsmith@acme.com</email> <leadSource>New Production ABC</leadSource> <originalSource> New Production ABC</originalSource> <originalSourceType>Web</originalSourceType> <customFields> <GamePreferences>Action</GamePreferences> <GamePlayed>121</GamePlayed> </customFields> </lead> <lead> <firstName>John</firstName> <lastName>Carmack</lastName> <company>ID Software</company> <phone>555-423-2453</phone> <email>jcarmack@idsoftware.ca</email> <leadSource>New Production ABC</leadSource> <originalSource> New Production ABC</originalSource> <originalSourceType>Web</originalSourceType> <customFields> <GamePreferences>Strategy</GamePreferences> <GamePlayed>23</GamePlayed> </customFields> </lead> </leads> </request> |
Bloc de code | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <response> <status>2001</status> <message>Lead emails synchronization successfull.</message> </response> |
...