| Sommaire | ||
|---|---|---|
|
...
Authentification
Les paramètres d’authentification 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 à 35 par seconde.
Champ du lead
Pour connaitre les champs du lead, veuillez consulter le 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és 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 |
Supporte | 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 | ||||
|---|---|---|---|---|
| ||||
<?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 | ||||
|---|---|---|---|---|
| ||||
<?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 | ||
|---|---|---|
| ||
<?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> |
Codes d'erreurs
| Bloc de code | ||||||
|---|---|---|---|---|---|---|
| ||||||
ERROR_EMAIL_IS_REQUIRED = 9001 ERROR_EMAIL_IS_INVALID = 9002 ERROR_EXTERNAL_ID_NOT_DEFINED = 9003 ERROR_LEAD_ALREADY_EXISTS = 9004 ERROR_LEAD_DOES_NOT_EXISTS = 9005 ERROR_LEAD_DOES_NOT_HAVE_ORIGINAL_SOURCE = 9006 ERROR_LEAD_DOES_NOT_HAVE_ORIGINAL_SOURCE_TYPE = 9007 ERROR_LEAD_UNSUPPORTED_CUSTOM_TAG = 9008 ERROR_LIST_DOES_NOT_EXISTS = 9009 ERROR_VIEW_DOES_NOT_EXISTS = 9010 ERROR_INVALID_XML = 9011 ERROR_LIST_INSIDE_FILTER_LIST = 9012 ERROR_ADD_LEAD_TO_LIST = 9013 ERROR_REMOVE_LEAD_FROM_LIST = 9014 ERROR_GET_LEAD = 9015 ERROR_ADD_LEAD = 9016 ERROR_UPDATE_LEAD = 9017 ERROR_SYNC_LEAD = 9018 STATUS_GET_LEADS = 2001 STATUS_GET_LEAD = 2002 STATUS_ADD_LEAD = 2003 STATUS_UPDATE_LEAD = 2004 STATUS_DELETE_LEAD = 2005 STATUS_SYNC_LEAD = 2006 STATUS_ADD_LEAD_TO_LIST = 2009 STATUS_REMOVE_LEAD_FROM_LIST = 2008 STATUS_ADD_LEADS_TO_LIST = 2009 |
...