Sommaire

Sommaire

Ce document fournit l’information nécessaire à la gestion des leads dans PUBLITRAC via l'API

URL

Environnement	URL
NormalGénéral	https://app.publitrac.com/api
Canadien	https://appca.publitrac.com/api

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.

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>

...

Get View

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

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

Exemples

Bloc de code

language	xml
title	Requête

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

Bloc de code

language	xml
title	Réponse

<?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
Supported	GET/POST
Méthode	getList
Paramètres obligatoires	method : getList apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe listName: Le nom de la liste filtrée.
Paramètres facultatifs	page: Page: Identifiant de page (défaut = 1)

Exemples

Bloc de code

language	xml
title	Requête

https://app.publitrac.com/api?method=getList&apiKey=abc&username=john&password=pass&viewName=Imported2012&page=1

Bloc de code

language	xml
title	Réponse

<?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 web visit history

Ajouter une visite web à un lead existant.


Url	https://app.publitrac.com/api
Supported	GET/POST
Méthode	addWebVisitHistory
Paramètres obligatoires	method : ‘addWebVisitHistory’addWebVisitHistory apiKey : Vôtre 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
language xml
title Requête
Exemple:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<webvisitleadhistory>
<request> <webvisitleadhistory> <information>/blog</information>
<context>Blog viewed</context>
<url>http
<context>Blog viewed</context> <url>http://www.acme.com/
blog<
blog</url>
<query>blog_post=product_abc_launch</query>
<referral>http
<referral>http://www.linkedin.com/home.php?udi=
1<
1</referral>
<ip>71.23.75.32</ip>
<userAgent>Mozilla/
<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
Requête Detail:
Information: Relative URL of the page hit. Context: Campaign name if applicable. Url: Absolute URL of the page hit.
Query: Query parameter of the page hit. Referral: Absolute referral URL.
IP: Client IP address.
User Agent: Client user-agent. Session ID: Client session id.

Réponse :
language xml
title Réponse
<?xml version="1.0" encoding="UTF-8"?>
<response>
<response> <status>3002</status>
<message>Add web page history success.</message>
</response>

Add click link history

Ajouter un clic de lien à un lead existant.


Url	https://app.publitrac.com/api
Supported	GET/POST
Method	addClickLinkHistory
Paramètres obligatoires	method : ‘addClickLinkHistory’addClickLinkHistory apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe email: L’adresse courriel du lead. query: L’information de l’historique du clic.
Paramètres facultatifs
Remarques	Le courriel du lead doit contenir moins de 50 caractères

Exemple

Bloc de code

language	xml
title	Requête

Exemple:
<?xml version="1.0" encoding="UTF-8"?>
<request>
<webvisitleadhistory>
<request> <webvisitleadhistory> <information>/blog</information>
<context>Blog viewed</context>
<url>http
<context>Blog viewed</context> <url>http://www.acme.com/
blog<
blog</url>
<query>blog_post=product_abc_launch</query>
<referral>http
<referral>http://www.linkedin.com/home.php?udi=
1<
1</referral>
<ip>71.23.75.32</ip>
<userAgent>Mozilla
<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

language
Requête Detail:
Information: Relative URL of the page hit. Context: Campaign name if applicable.
Url: Absolute URL of the page hit.
Query: Query parameter of the page hit. Referral: Absolute referral URL.
IP: Client IP address.
User Agent: Client user-agent. Session ID: Client session id.

Réponse :
xml
title Réponse
<?xml version="1.0" encoding="UTF-8"?>
<response>
<response> <status>3003</status>
<message>Add click link history success.</message>
</response>

Add fill out form history

Ajouter un formulaire soumis à un lead existant.

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

...

POST
Méthode	addFillFormHistory
Paramètres obligatoires	method :

...

addFillFormHistory apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe email: L’adresse courriel du lead. query: L’information du formulaire soumis.
Paramètres facultatifs
Remarques	Le nom du formulaire (formName) doit être un formulaire valide dans PUBLITRAC.
Remarques	Le courriel du lead doit contenir moins de 50 caractères

Requête Exemple:

Exemple

Bloc de code

language	xml
title	Requête


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

...

<request>

<fillformleadhistory>

<information>Registration Form</information>

<context></context>

<formName>Infolettre</formName>


<request>
    <fillformleadhistory>
        <information>Registration Form</information>
        <context></context>
        <formName>Infolettre</formName>
        <url>/infolettre.php</url>

...

<values>


        <values>
            <![CDATA[

...



Firstname: Claude

...



Lastname: Sage

...



Email: claude@sage.com

...



Phone: 555-666-7777

...

]]>

...


        </values>

...


        <sessionId>2192c0f3802f8e0744e9940788121624</sessionId>

...


    </fillformleadhistory>

...


</request>

...

Bloc de code

...

language

...

xml

...

<request>

<fillformleadhistory>

<information>Registration Form</information>

<context></context>

<formName>Registration Form</formName>

<url>/registration.php</url>

<values>

<![CDATA[

Firstname: Jean-Francois

Lastname: Buist

Email: jfbuist@publitrac.com

Phone: 514-893-2149

]]>

</values>

<sessionId>2192c0f3802f8e0744e9940788121624</sessionId>

</fillformleadhistory>

</request>

Requête Detail:

Information: Name of the form. Context: Campaign name if applicable.

Form Name: Name of the form created in the application.

Query: Url of the page containing the form. Values: Name/value set of form posted. Session ID: Client session id.

Réponse :
title Réponse
<?xml version="1.0" encoding="UTF-8"?>
<response>
<response> <status>3004</status>
<message>Add fill form history success.</message>
</response>

Note:
Le formulaire doit exister dans l’application.

Get campaigns

Récupérer toutes les campagnes de suivis.


Url	https://app.publitrac.com/api/api
Supported	GET/POST
Méthode	getCampaigns
Paramètres obligatoires	method : ‘getCampaigns’ apiKey : Vôtre clef API username : Vôtre nom d’usager password : Vôtre mot de passe
Paramètres facultatifs	page: Page: Identifiant de page (défaut = 1)
Remarques

Exemples :

GET : https://app.publitrac.com/api?method=getCampaigns&apiKey=abc&username=john&passwor d=pass&page=1

Réponse :

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

<response>

<campaign>

<id>2071</id>

<Name>AdCenter - Drip Marketing</Name>

<Type>Paid Search</Type>

<Token>CMP-4d7147b0dd389</Token>

<CampaignType>CAMPAIGNTRACKING</CampaignType>

<Created_Date>2011-03-04 20:12:32</Created_Date>

<Last_Updated>2011-12-08 01:10:14</Last_Updated>

</campaign>

<campaign>

<id>2211</id>

<Name>AdCenter - Internet Marketing Software</Name>

<Type>Paid Search</Type>

<Token>CMP-4dc2ebfe7a3f2</Token>

<CampaignType>CAMPAIGNTRACKING</CampaignType>

<Created_Date>2011-05-05 18:27:10</Created_Date>

<Last_Updated>2011-12-08 01:10:14</Last_Updated>

</campaign>

Get opportunities

Récupérer les opportunités par lead.


Url	https://app.publitrac.com/api/api
Supported	GET/POST
Méthode	getOpportunities
Paramètres obligatoires	method : ‘getOpportunities’ apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe
Paramètres facultatifs	page: Page: Identifiant de page (défaut = 1)
Remarques

Exemples :

GET : https://app.publitrac.com/api?method=getOpportunities&apiKey=abc&username=john&passw ord=pass&page=1

POST :

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

POST CONTENT :

method=getOpportunities

&apiKey=abc

&username=john

&password=pass

&page=1

Réponse :

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

<response>

<opportunities>

<opportunity>

<id>1</id>

<Name>PUBLITRAC</Name>

<Description>Marketing Automation Solution</Description>

<Opportunity_Type>Web</Opportunity_Type>

<Account_Name>PUBLITRAC</Account_Name>

<Campaign_Name>Marketing Automation</Campaign_Name>

<Lead_Source></Lead_Source>

<Amount>9000</Amount>

<Date_Closed>2010-10-10</Date_Closed>

<Sales_Stage>Closed Won</Sales_Stage>

<Probability>100</Probability>

<External_id>My ID</External_id>

<Account>1</Account>

<Created_Date>0000-00-00 00:00:00</Created_Date>

<Last_Updated>0000-00-00 00:00:00</Last_Updated>

</opportunity>

</opportunities>

<paging>

<page>1<page>

<items>1</items>

...

<offset>200</offset>

<total>1</total>

</paging>

<status>5001</status>

<message>Get opportunities success.</message>

</response>

Sync opportunity

Insérer ou mettre à jour une opportunité pour un lead.


Url	https://app.publitrac.com/api/api
Supported	GET/POST
Méthode	syncOpportunity
Paramètres obligatoires	method : ‘syncOpportunity’ apiKey : Vôtre clef API username : Votre nom d’usager password : Votre mot de passe query: La représentation XML d’une opportunité (voir à la fin du document pour plus d’information).
Paramètres facultatifs
Remarques	Si l’opportunité n’existe pas avec comme identifiant le ‘id’. L’appel API va créer l’opportunité.

Exemples : Requête :

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

<request>

<opportunity>

<id>Product ABC</id>

<name>Promotion Product ABC</name>

<description>Product ABC is a revolutionary…</description>

<type>New Business</type>

<accountName>XYZ Solutions</accountName>

<salesStage>Closed Won</salesStage>

<campaignName>LinkedIn</campaignName>

<leadSource>Web</leadSource>

<amount>100000</amount>

<dateClosed>20/08/2012</dateClosed>

<probability>100</probability>

<leads>

<leadId>ae389ecc-e998-85b9-4c9f-4c8d13581a9b</leadId>

</leads>

</opportunity>

</request>

Réponse :

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

<response>

<status>5002</status>

<message>Opportunity synchronized.</message>

</response>

**Note: Le ‘leadId’ doit être le ‘ExternalId’ utilisé précédement dans syncLead().

...

Add emails campaign: Exécuter une campagne de marketing par courriel sur un ou des leads.

<?xml version="1.0" encoding=" UTF-8"?>
<request>
    <fillformleadhistory>
        <information>Registration Form</information>
        <context></context>
        <formName>Infolettre</formName>
        <url>/infolettre.php</url>
        <values>
            <![CDATA[

Firstname: Claude

Lastname: Sage

Email: claude@sage.com

Phone: 555-666-7777

]]>
        </values>
        <sessionId>2192c0f3802f8e0744e9940788121624</sessionId>
    </fillformleadhistory>
</request>

Comparaison des versions

Ancienne version 15

Nouvelle version 16

Légende

Sommaire

URL

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get View

Exemples

Get List

Exemples

Add web visit history

Exemples

Add click link history

Exemple

Add fill out form history

Exemple

Get campaigns

Get opportunities

Sync opportunity

Comparaison de pages

Comparaison des versions

Ancienne version 15

Nouvelle version 16

Légende

Sommaire

URL

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get View

Exemples

Get List

Exemples

Add web visit history

Exemples

Add click link history

Exemple

Add fill out form history

Exemple

Get campaigns

Get opportunities

Sync opportunity