Sommaire

maxLevel	2

Authentification

Les paramètres d’authentifications 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 Liste et description des champs du lead.

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:ii: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é 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
Supported	GET
Méthode	getLeads
Paramètres obligatoires	method : getLeads apiKey : Vôtre 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

language	xml
title	Requête

<?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

language	xml
title	Réponse

<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 reuqête vide, voir exemple ci-dessous:

Bloc de code

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <queries></queries>
</request>

Get lead

Rechercher un lead par son courriel

Url	https://app.publitrac.com/api
Supported	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

language	xml
title	Requête

https://app.publitrac.com/api?method=getLead&apiKey=myApiKey&username=john&password=pass&email=johnsmith@publitrac.com

Bloc de code

language	xml
title	Réponse

<?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>

...

Url	https://app.publitrac.com/api
Supported	POST
Méthode	executeCampaign
Paramètres obligatoires	method : executeCampaign apiKey : Vôtre 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 leads et plusieurs campagnes. Si plusieurs leads avec la même adresse courriel existent, seulement la première occurrence sera traitée. À noter que si les leads et les campagnes n’existent pas, rien ne sera exécuté et aucune auto création ne sera opérée.

Exemples

Bloc de code

language	xml
title	Requête

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <leads>
        <lead></lead>
        <lead></lead>
    </leads>
    <campaigns>
        <email>johnsmith@acme.com</email>
        <email>csage@ acme.com</email>
        <campaign>
            <name>Trade Show May</name>
        </campaign>
    </campaigns>
</request>

Bloc de code

language	xml
title	Réponse	collapse	true

<?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
Supported	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.
Remarques	Le nom de la campagne doit contenir moins de 50 caractères

Exemples

Bloc de code

language	xml
title	Requête

?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
                </Buyin>
                <GamePlayed>121
                </Buyin>
            </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
                </Buyin>
                <GamePlayed>23
                </Buyin>
            </customFields>
        </lead>
    </leads>
</request>

Bloc de code

language	xml
title	Réponse

<?xml version="1.0" encoding="UTF-8"?>
<response>
          <status>2001</status>
          <message>Lead emails synchronization successfull.</message>
</response>

Paramètres de recherche

L’XML soumis comme le paramètre de la ‘requête’ doit être correctement encodé.

1. Requête de recherche

La requête de recherche XML permet d’effectuer une recherche en fonction de toutes les propriétés du lead.

<?xml version="1.0" encoding="UTF-8"?>

<request>

<queries>

<query>

<field>firstName</field>

<operator>Like</operator>

<value>Al%</value>

</query>

<query>

<field>lastnName</field>

<operator>=</operator>

<value>Smith</value>

</query>

</queries>

</request>

À noter qu’une recherche de tous les leads peut être appliquée avec une recherche vide, voir exemple ci-dessous:

<?xml version="1.0" encoding="UTF-8"?>

<request>

<queries>

</queries>

</request>

2. Objet d’un Lead

La structure Xml suivante représente le lead à insérer ou à mettre à jour.

Champs à valider:

- Email: Must be a valid email format.

- Status:

o Active

o Inactive

- Score: Integer.

- Do not call: 0 or 1.

- Unsubscribe: 0 or 1.

- IsCustomer: 0 or 1.

- IsAnonymous: 0 or 1.

- EmailInvalid: 0 or 1.

- Suspended: 0 or 1.

- Blacklisted: 0 or 1.

- Customer Id: Integer.

- Language:

o Fr

o En

- NbrEmployees: Integer

- Revenue: Integer

Exemple:

<?xml version="1.0" encoding="UTF-8"?>

<request>

<lead>

<crmLeadId>1234abc</crmLeadId>

<firstName>John</firstName>

<lastName>Smith</lastName>

<middleName>W.</middleName>

<company>Publipage</company>

<phone>514-555-2149</phone>

<email>johnsmith@publitrac.com</email>

<mailingAddress>123 Street</mailingAddress>

<leadSource>Webinar</leadSource>

<originalSource>Google</originalSource>

<originalSourceType>Search Engine</originalSourceType>

<keyword>Marketing</keyword>

<jobTitle>IT</jobTitle>

<dateOfBirth>1978/04/18</dateOfBirth>

<score>30</score>

<postalCode>J1J 1J1</postalCode>

<country>Canada</country>

...

Comparaison des versions

Ancienne version 21

Nouvelle version 22

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get lead

Exemples

Exemples

Add emails campaign

Exemples

Comparaison de pages

Comparaison des versions

Ancienne version 21

Nouvelle version 22

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get lead

Exemples

Exemples

Add emails campaign

Exemples