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]

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

Remarques
Bloc de code

language

xml
Exemples :
title
GET :
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>


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


            <state></state>
            <doNotCall>0</doNotCall>
            <doNotCallReason></doNotCallReason>
            <token>_nl-publipage.com-1282527313351-84730</token>

...

<unsubscribed>0</unsubscribed>

</lead>

</leads>

<paging>

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


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

<page>1</page>

<items>1</items>

<offset>100</offset>

<total>1</total>

</paging>

<status>2001</status>

...


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

Url
https://app.publitrac.com

...

/api

Supported

...

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.

Object de requête:

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.

...

Bloc de code

language	xml
title	Requête

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

...

<request>

<list>

</list>

<leads>

<name>The name of the list to add to</name>

<lead>

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

</lead>

<lead>

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

</lead>

</leads>

</request>

Réponses possible :

On Success

...


<request>
    <list></list>
    <leads>
        <name>The name of the list to add to</name>
        <lead>
            <email>someone1@publitrac.com</email>
        </lead>
        <lead>
            <email>someone2@publitrac.com</email>
        </lead>
    </leads>
</request>

Bloc de code

language	xml
title	Réponse (Succes)

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

...

<response>


<response>
    <status>2009</status>

...


    <message>Success.</message>

...


</response>

...

On Failure
Bloc de code
language xml
title Réponse (échec)
<?xml version="1.0" encoding="UTF-8"?>
<response>
<error>
<leadNotFound>someone1@gmail.com</leadNotFound>
<leadNotFound>someone2@gmail.com</leadNotFound>
<error/>
<statuts>9501</status>
<message> Leads not found</message>
</response>
<response> <error> <leadNotFound>someone1@gmail.com</leadNotFound> <leadNotFound>someone2@gmail.com</leadNotFound> </error> <statuts>9501 </status> <message> Leads not found</message> </response>

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

Requête Exemple:

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

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 version="1.0" encoding="UTF-8"?>

<response>

<status>3002</status>

<message>Add web page history success.</message>

</response>

...

Comparaison des versions

Ancienne version 13

Nouvelle version 14

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get List

Exemples

Add leads to list

Exemples

Add web visit history

Comparaison de pages

Comparaison des versions

Ancienne version 13

Nouvelle version 14

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Format

Structure XML

Index des méthodes

Get leads

Exemples

Get List

Exemples

Add leads to list

Exemples

Add web visit history