Sommaire

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]

Exemple

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.

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.

Exemple

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>

...

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>

Sync Lead

Synchroniser un ou plusieurs leads en même temps (si existe par courriel, une mise à jour sera effectuée).


Url	https://app.publitrac.com/api

...

Supported

...

POST
Méthode	syncLead
Paramètres obligatoires	method :

...

Exemple: Requête

Une liste des champs et leurs descriptions est disponible ici.

...

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 (voir la fin du document pour plus d’information).

...

Paramètres facultatifs

...

customUnicityKeys : Sert à déterminer les clés et leurs ordres d’importance pour l’enregistrement des Leads.

Exemple de clés, permettant de déterminer l’ordre d’importance des

champs:

<key>token</key>

<key>crmLeadId</key>

<key>email</key>

</customUnicityKeys>

Vous pouvez aussi créer des clés multiples en séparant les champs désirés par une virgule.

Exemple de clé multiple :

<key>email, firstName, lastName</key>

</customUnicityKeys>

Lors de la synchronisation des Leads, l’application cherchera à faire une correspondance avec les enregistrements par les clés dans l’ordre défini. Comme dans notre exemple ci-bas, par token en premier, suivit de par le crmLeadId et ensuite le email si non trouvé par les clés préalablement définies.

...

Remarques

...

Cette méthode synchronise les leads. Si le ‘token’, le ‘crmLeadId’ ou le courriel existe dans la base de données, le lead sera mis à jour. Sinon, il sera créé. L’adresse courriel est toujours obligatoire et doit être valide.

Remarques

Cette méthode synchronise les leads. Si le ‘token’, le ‘crmLeadId’ ou le courriel existe dans la base de données, le lead sera mis à jour. Sinon, il sera créé. L’adresse courriel est toujours obligatoire et doit être valide.

Exemple

Bloc de code

language	xml
title	Requête

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

...

<key>token</key>

<key>crmLeadId</key>

<key>email</key>

</customUnicityKeys>

<lead>


<request>
    <lead>
        <useToken>true</useToken>
        <token>_nl-yourdomain.com-1323891914130-53205</token>

...


        <crmLeadId>CRM_ID134</crmLeadId>

...


        <firstName>John</firstName>

...

<lastName>Smith</lastName>


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

...

<city>Compton</city>


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

...

<notes>This lead is very interest in product ABC</notes>

...


        <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></customerId>
        <website>http://www.acme.

...

com</website>

...


        <language>fr</language>

...

<carMaker>Infiniti</carMaker>

<list> <!—list and item are mandatory, other values are customs à

<item>

<name>Premium</name>

<desc>Lorem</desc>

</item>

<item>

<name>Best Value</name>

<desc>Lorem</desc>

</item>

</list>

</carPackagesInterestedIn >

</customFields>

</lead>

</request>

Réponse :

<?xml


        <nbrEmployees>4</nbrEmployees>
        <revenue>400000</revenue>
        <customFields>
            <carColor>Red</carColor>
            <carMaker>Infiniti</carMaker>
        </customFields>
    </lead>
</request>

Bloc de code

language	xml
title	Réponse

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


<response>
    <status>2006</status>

<mssage>Update lead


    <message>Update lead success.</message>

+-


</response>

Get View

Récupérer les leads qui font partie d’une liste filtrée.


Url	https://app.publitrac.com/api
Supported	GET/POST
Méthode	getView
Paramètres obligatoires	method : ‘getView’ apiKey : Votre clef API username : Votre nom d’usager password : Votre mot de passe viewName: Le nom de la liste filtrée.
Paramètres facultatifs	page: Identifiant de page (défaut = 1)
Remarques

Exemples :

GET : https://app.publitrac.com/api?method=getView&apiKey=abc&username=john&password=pas s&viewName=PromoABC_Email_Open&page=1

Réponse :

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

<response>

<leads>

...

Comparaison des versions

Ancienne version 11

Nouvelle version 12

Légende

Authentification

Paramètres

Syntaxe

Exemple

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemple

Get lead

Exemples

Sync Lead

Exemple

Get View

Comparaison de pages

Comparaison des versions

Ancienne version 11

Nouvelle version 12

Légende

Authentification

Paramètres

Syntaxe

Exemple

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemple

Get lead

Exemples

Sync Lead

Exemple

Get View