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 Lexique et champs natifs (disponibles par défaut).

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:mm: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 : Votre 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

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

Bloc de code

language	xml

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

...

Add click link history

Ajouter un clic de lien à l'historique d'un lead existant.

Url	https://app.publitrac.com/api
Supported	POST
Method	addClickLinkHistory
Paramètres obligatoires	method : 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

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

Bloc de code

language	xml
title	Réponse

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

...

Get campaigns

Récupérer toutes les campagnes de suivis.

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

Exemple

Bloc de code

language	xml
title	Requête

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

Bloc de code

language	xml
title	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>
	<status>5001</status>
    <message>Get campaigns success.</message>
</response>

...

Url	https://app.publitrac.com/api
Supported	POST
Méthode	executeCampaign
Paramètres obligatoires	method : executeCampaign apiKey : Vôtre Votre 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 courriels et plusieurs campagnes. Si plusieurs leads avec la même adresse courriel existent, seulement la première occurrence du courriel sera traitée. À noter tout les leads spécifiés seront assigné à la campagne défini, si un lead ou une des campagnes spécifiés n'existe pas dans votre compte, rien ne sera traité. À noter que si aucun lead correspondant au courriel ou qu'aucune campagne n’existent selon les critères de recherche, aucune action 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>
			<email>test@exemple.com</email>
		</lead>
		<lead>
			<email>johnsmith@acme.com</email>
		</lead>
    </leads>
    <campaigns>        
        <campaign>
            <name>Trade Show May</name>
        </campaign>
    </campaigns>
</request>

Bloc de code

language	xml
title	Réponse

<?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.
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</GamePreferences> <GamePlayed>121</GamePlayed> </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</GamePreferences> <GamePlayed>23</GamePlayed> </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>

...

Objet opportunité

Champs obligatoires:

Id: Your system ID to identify the opportunity l'identifiant unique de votre système.
Name: The name of the opportunity. Le nom de votre opportunité.
Sales Stages:
Prospecting
Qualification
Needs Analysis
Value Proposition
Id. Decision Makers
Perception Analysis
Proposal/Price Quote
Negotiation/Review
Closed Won
Closed Lost
Amount: Integer - valeur monétaire associé à la vente potentiel
Date Closed: Mandatory if opportunity is closed. Use your own data formatSous le format « yyyy-mm-dd »..
Probability: Integer from nombre entre 1 to et 100
Leads: List of lead ids attached to the opportunity. ID is your internal crmLeadId and must have been previously added using addLead method Liste des lead id assigné à l'opportunité. ID est l'identifiant unique de votre lead dans votre CRM, il doivent au préalable avoir été ajouté à la base de données PUBLITRAC via la méthode addLead dans le champ ExternalID.

Exemple

Bloc de code

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <opportunity>
        <id>1234abc</id>
        <name>PUBLITRAC</name>
        <description>Marketing Automation Solution</description>
        <type>Web</type>
        <accountName>PUBLITRAC</accountName>
        <salesStage>Closed Won</salesStage>
        <campaignName>Webinar</campaignName>
        <leadSource>Web</leadSource>
        <amount>9000</amount>
        <dateClosed>2010-10-10</dateClosed>
        <probability>100</probability>
        <leads>
            <leadId>456zxy</leadId>
        </leads>
    </opportunity>
</request>

Comparaison des versions

Ancienne version 43

Nouvelle version 44

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Add click link history

Exemple

Get campaigns

Exemple

Exemples

Add emails campaign

Exemples

Objet opportunité

Exemple


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 43

Nouvelle version 44

Légende

Authentification

Paramètres

Syntaxe

Exemples

Clé d'API

Limitation

Champ du lead

Format

Structure XML

Index des méthodes

Get leads

Exemples

Add click link history

Exemple

Get campaigns

Exemple

Exemples

Add emails campaign

Exemples

Objet opportunité

Exemple