API Technical Reference

Transcription

1 API Technical Reference Copyright 1996/2015, Quality System Solutions Limited Unit 8 Lansdowne Court Bumpers Way, Chippenham, Wiltshire, SN13 0RP United Kingdom Tel: +44 (0) support@callprocrm.com Web:

2 Contents 1. Creating a new account Adding contact history Updating existing accounts Updating existing contacts Exporting account details Reporting CallPro CRM tables and fields

3 1. Creating a new account New accounts can be created from an external program by submitting xml via a POST http request: <path to CallPro CRM installation>/api.php?mode=import&hash=<hash> Parameters <hash> is a md5 hash of the CallPro CRM login username concatenated with a colon and the user password. This can be found by going to the menu option Setup/User-profiles. Click on a name, then click the View button for Advanced, the hash is displayed at the top of the screen. The xml is submitted in a post variable called xml There is only a return value if an error occurred. Example XML <?xml version="1.0"?> <importdata> <area>001</area> <data> <notify>admin@company.com</notify> <account> <field table="telrcm" field="company">test Industries</field> <field table="telrcm" field="postcode">aa01 0AA</field> <field table="telrcm" field="telephone"> </field> <field table="telrcm" field="customerstatus">not called</field> <field table="telrcm" field="owner">new data</field> <field table="rcmanl" field="anal01">25</field> </account> <field table="cont" field="contact">test 1</field> <field table="cont" field=" ">test@a.com</field> <field table="cont" field="contact">test 2</field> <field table="cont" field=" ">test@aa.com</field> </data> <data> </data> </importdata> <field table="cont" field="contact">test 3</field> <field table="cont" field=" ">test@aaa.com</field> <notify>admin@company.com</notify> <account> <field table="telrcm" field="company">test2 Industries</field> <field table="telrcm" field="postcode">aa01 0AA</field> <field table="telrcm" field="telephone"> </field> <field table="telrcm" field="customerstatus">not called</field> <field table="telrcm" field="owner">new data</field> <field table="rcmanl" field="anal01">25</field> </account> <field table="cont" field="contact">test 11</field> <field table="cont" field=" ">test@a.com</field> <field table="cont" field="contact">test 22</field> <field table="cont" field=" ">test@aa.com</field> <field table="cont" field="contact">test 33</field> <field table="cont" field=" ">test@aaa.com</field> 3

4 Note: The Notify tag used in example can be used to send an or CallPro CRM message to users. Multiple tags are supported (add each CallPro CRM User or address on a newline), so you can and message several people at once. If the notify value contains sign, it is presumed to be a valid address, otherwise an CallPro CRM user. Example PHP Script Note: This is only an example of how the api can be used from a PHP script. Actual script will depend on user implementation requirements. <?php /**************************************************************** Creating new accounts via the CallPro CRM API example ****************************************************************/ //example data $notify = "CallProCRMuser1"; //$notify = "user1@callprocrm.com"; $company = "Silver Industries2"; $postcode = "AA01 0AA"; $telephone = " "; $name = "John Smith"; $ = "john.smith@jsindustries.co.uk"; $customerstatus = "Not called"; $owner = "New data"; $employees = "25"; //To update an record ensure that the account number is provided //$accountno = "12345"; //to insert data into the system we need a username and password $hash = "1debf279286ed ccd7b843f04a"; //define what area to insert to $area = "001"; //creating the xml document $doc = new DOMDocument('1.0'); $doc->formatoutput = true; //everything is contained in the import data tag $importdata = $doc->createelement("importdata"); $doc->appendchild($importdata); //Element for target area $area = $doc->createelement("area",$area); $importdata->appendchild($area); //Create data tag $data = $doc->createelement("data"); //Create Notify element $notify = $doc->createelement("notify",$notify); $data->appendchild($notify); $importdata->appendchild($data); //Create account tag $account = $doc->createelement("account"); //Create account number if using custom number, uncomment 2 lines below //$accountno = $doc->createelement("accountno",$accountno); //$account->appendchild($accountno); //Create account elements $j = $doc->createelement("field",$company); $j->setattribute("table", "TELRCM"); $j->setattribute("field", "COMPANY"); $account->appendchild($j); $j = $doc->createelement("field",$postcode); $j->setattribute("table", "TELRCM"); $j->setattribute("field", "POSTCODE"); $account->appendchild($j); $j = $doc->createelement("field",$telephone); $j->setattribute("table", "TELRCM"); $j->setattribute("field", "TELEPHONE"); $account->appendchild($j); $j = $doc->createelement("field",$customerstatus); $j->setattribute("table", "TELRCM"); $j->setattribute("field", "CUSTOMERSTATUS"); $account->appendchild($j); $j = $doc->createelement("field",$owner); $j->setattribute("table", "TELRCM"); $j->setattribute("field", "OWNER"); $account->appendchild($j); $j = $doc->createelement("field",$employees); $j->setattribute("table", "RCMANL"); $j->setattribute("field", "ANAL30"); 4

5 $account->appendchild($j); $data->appendchild($account); //Create contact elements. //Can have more than one contact $contact = $doc->createelement("contact"); $k = $doc->createelement("field",$name); $k->setattribute("table", "CONT"); $k->setattribute("field", "CONTACT"); $contact->appendchild($k); $k = $doc->createelement("field",$ ); $k->setattribute("table", "CONT"); $k->setattribute("field", " "); $contact->appendchild($k); //To update contact details provide an Contact_ID // $k = $doc->createelement("field",$cid); // $k->setattribute("table", "CONT"); // $k->setattribute("field", "CID"); // $contact->appendchild($k); $data->appendchild($contact); $xml = $doc->savexml(); //Change this to the long url of your system, if unsure what this is please //ask support $url = " $hash; //start curl $ch = curl_init(); //set the url, number of POST vars, POST data $data = array("xml" => $xml); curl_setopt($ch,curlopt_url, $url); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE); //execute post $result = curl_exec($ch); //close curl connection curl_close($ch); echo $result;?> Parameters for the Creating New Account code can be passed from a web form. A simple example of the web form would be. <form action="includes/cpcupload.php" method="post" enctype="multipart/form-data"> <input name="name" type="text">name<br> <input name=" " type="text"> <br> <input type="submit"> </form> The php code, cpcupload.php in the above example, would retrieve the name and values into the $contact and $ variables $contact = $_POST['name']; $ = $_POST[' ']; On Submit, cpcupload.php will create the request and send to CallPro CRM. A new record will be created automatically. If the Notify field is used then either an internal message will be sent to the CallPro CRM user and/or to the notification address. 5

6 1. Adding contact history Contact history can be created by simply adding an activity and optionally comments. Example PHP code $f = $doc->createelement("field", Web Submission ); $f->setattribute("table", "SPECIAL"); $f->setattribute("field", "ACTIVITY"); $r->appendchild($f); $f = $doc->createelement("field", This account was created by a web submission ); $f->setattribute("table", "SPECIAL"); $f->setattribute("field", "COMMENTS"); $r->appendchild($f); 2. Updating existing accounts To update an existing account simply add to the XML post data specifying the CallPro CRM account number to update within the account tags: <accountno> </accountno> If no contact details are provided then only the account information will be updated. 3. Updating existing contacts To update an existing contact simply add to the XML post data specifying the CallPro CRM contactid to update: <field table="cont" field="cid">1234</field> <field table="cont" field="contact">test 33</field> <field table="cont" field=" ">test@aaa.com</field> 6

7 4. Exporting account details Account information can be retrieved by a simple GET http request: <path to CallPro CRM installation>/api.php?mode=export&hash=<hash>&account=<account>&area=<area> Parameters <hash> is a md5 hash of an CallPro CRM login username concatenated with a colon and the user password. This can be found by going to the menu option Setup/User-profiles. Click on a name, then click the View button for Advanced, the hash is displayed at the top of the screen. <account> is the CallPro CRM account number to retrieve data for. <area> is the database area number where the account is located in. An optional extra parameter is project which is applicable if multiple projects is enabled in the Database Area. Example response <?xml version="1.0"?> <TELRCM> <ACCOUNT>034</ACCOUNT> <COMPANY>Electronics</COMPANY> <ADDRESS1>2 Grafton Road</ADDRESS1>... </TELRCM> <RCMANL> <ACCOUNT>034</ACCOUNT> <LINE>1</LINE> <COMPANY></COMPANY> <ANAL01></ANAL01>... <ANAL58></ANAL58> <ANAL59></ANAL59> <ANAL60></ANAL60> </RCMANL> <CONT> <ACCOUNT>034</ACCOUNT> <CONTACT>Bill</CONTACT> <SALUTATION>Mr Bill</SALUTATION>... </CONT> <CONT> <ACCOUNT>034</ACCOUNT> <CONTACT>John Smith</CONTACT>... </CONT> 7

8 5. Reporting Reports can be accessed in either CSV, XML or Excel formats using a simple URL: <path to CallPro CRM installation>/api.php?mode=report&hash=<hash>&type=<report type>&name=<report name>&format=<format> Parameters <type> can either be SQL or RW dependant if the report is SQL report or a report writer report. <name> is the name of the report. <format> is either csv, xml or excel. If omitted or an unknown format is used, CallPro CRM will output a CSV file. 8

9 6. CallPro CRM tables and fields TELRCM (Account Information) ACCOUNT COMPANY ADDRESS1 ADDRESS2 ADDRESS3 ADDRESS4 POSTCODE COUNTRY TELEPHONE FAX NEXTDATE LASTDATE FIRSTDATE NOTE DISCOUNT USERNAME OWNER ACSTATUS CUSTOMERSTATUS SUBSTATUS STATUSDATE SALESMAN PROJECT TIMEST WWW LASTUSER SAVEDATE ADDNOTE text varchar(25) varchar(25) varchar(25) varchar(100) text CONT (Contact Information) ACCOUNT CONTACT SALUTATION POSN COMPANY MEMO TYPE_ PRIMARY_ NEXTDATE ADDN01... ADDN60 FIRSTNAME OWNER STATUS SUBSTATUS TITLE SURNAME INITIALS text varchar(1) varchar(30) varchar(25) varchar(25) 9

10 TELEPHONE FAX ADDRESS1 ADDRESS2 ADDRESS3 ADDRESS4 POSTCODE COUNTRY MOBILE CID SAVEDATE varchar(100) varchar(15) int(11) RCMANL (Additional Fields) ACCOUNT ANAL01 ANAL60 varchar(100) varchar(100) 10