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>

...

Sync opportunity

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

Url	https://app.publitrac.com/api
Supported	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é. Le ‘leadId’ doit être le ‘ExternalId’ utilisé précédement dans syncLead().

Exemples : Requête :

Exemple

Bloc de code

language	xml
title	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>


<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
<leads> <leadId>ae555ecc-e998-85b9-4c9f-4c8d13581a9b</leadId>
</leads>
</opportunity>
</request>

Bloc de code
language xml
title Réponse
:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<response> <status>5002</status>
<message>Opportunity synchronized.</message>
</response>
**Note: Le ‘leadId’ doit être le ‘ExternalId’ utilisé précédement dans syncLead().

Execute campaigns on leads

Exécuter une campagne donnée sur un lead.

...

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>

Response :

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

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 {{FirstName;Default=}}. There is a new promotion this year… </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>

...

Comparaison des versions

Ancienne version 20

Nouvelle version 21

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Sync opportunity

Exemple

Execute campaigns on leads

Exemples

Add emails campaign

Exemples


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

Comparaison de pages

Comparaison des versions

Ancienne version 20

Nouvelle version 21

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Sync opportunity

Exemple

Execute campaigns on leads

Exemples

Add emails campaign

Exemples