Personal tools

Log in

Changes

From All n One's bxp software Wixi

Jump to: navigation, search

Bxp API

4 bytes added, 21:44, 13 July 2014
no edit summary
The current version is 5-0-3.
 
 
== Website Integrations ==
 
 
For websites bxp provides read and write ability that is controlled by the website. These facilities can be applied to provide:
 
* Custom account management
* Customer Relationship Management
* Membership management
* Event management
* Appointment management
* Payment processing solution recording and management
* List or publication management
* CPD (Continuing Professional Development) point management
 
 
 
== Mobile and Tablet App Integrations ==
 
 
As with website integrations it is possible for a mobile / tablet app to interact with bxp but it must be through a centralised website interaction. i.e. the App does not come directly to bxp.
 
It is possible to design one of two types of app:
* A native / hybrid app
* A mobile web app
 
 
For reference further discussions on the topic can be found here:
* http://www.nngroup.com/articles/mobile-native-apps/
* http://thenextweb.com/dd/2014/02/08/decide-responsive-website-native-mobile-app/
* http://mobiledevices.about.com/od/additionalresources/a/Native-Apps-Vs-Web-Apps-Which-Is-The-Better-Choice.htm
* http://sixrevisions.com/mobile/native-app-vs-mobile-web-app-comparison/
 
 
The native app will work locally on the device and will not be required to interact with live data. Certain aspects of the interaction can be simple listings but this information should be public information. A native app will require communication with an intermediate communications application as direct contact between bxp and the app could not be easily IP address locked.
 
A portal app is a redirect to an app aware and enabled web page. This enabled website is what will communicate directly with bxp and control what functions the app will have access to.
 
 
 
== Computer Telephony Integration (CTI) ==
 
 
There are many instances where the phone system has valuable information. The incoming call will have the line the call came in on (DNIS), the callers number (CLID), the agent / extension the call was delivered to ( agentid / ext ) and if the call goes through an IVR a number of other key pieces of information can be gathered before it even gets to the agent.
 
 
Often these solutions have the ability to open a web page and pass information via the querystring. For this reason the phone system may not be able to POST to bxp but can pass information via the querystring.
 
 
The most common function for this in the API is 7.3.5 Login + Data Management + Data Logging. This allows for a number of parameters to be passed in and the
 
 
<syntaxhighlight lang="php" line start="2">
https://ww3.allnone.ie/client/client_demo/cti/userCTI_GenericEntry.asp?system=datalogging&user_id=abc123&user_key=passkey&campaign_code=CODE_001&parameterA=passedDataA&parameterB=passedDataB
</syntaxhighlight>
 
 
Each of the parameters can be read in and logged in specific fields. The form can then also be extended using AJAX to perform a LiveSearch to see if the customer has other cases or records in the system.
 
 
 
== 3rd Party Software Integration ==
 
 
It is also possible to integrate bxp into other applications. Using the same POST and querystring approach, bxp can be built into any SDK environment.
 
* ASP: demonstrated in the BEAPI
* ASP.Net: http://msdn.microsoft.com/en-us/library/debx8sh9.aspx
* C: http://www.linuxquestions.org/questions/programming-9/how-can-i-post-data-with-post-method-in-c-programming-542700/
* C++: http://stackoverflow.com/questions/1011339/how-do-you-make-a-http-request-with-c
* C#: http://stackoverflow.com/questions/5401501/how-to-post-data-to-specific-url-using-webclient-in-c-sharp
* Java: http://stackoverflow.com/questions/4205980/java-sending-http-parameters-via-post-method-easily
* Objective C: http://stackoverflow.com/questions/15749486/sending-an-http-post-request-on-ios
* PHP: demonstrated in the BEAPI
 
 
== Website Integrations ==
 
For websites bxp provides read and write ability that is controlled by the website. These facilities can be applied to provide:
 
* Custom account management
* Customer Relationship Management
* Membership management
* Event management
* Appointment management
* Payment processing solution recording and management
* List or publication management
* CPD (Continuing Professional Development) point management
 
 
== Mobile and Tablet App Integrations ==
 
 
As with website integrations it is possible for a mobile / tablet app to interact with bxp but it must be through a centralised website interaction. i.e. the App does not come directly to bxp.
 
It is possible to design one of two types of app:
* A native / hybrid app
* A mobile web app
 
 
For reference further discussions on the topic can be found here:
* http://www.nngroup.com/articles/mobile-native-apps/
* http://thenextweb.com/dd/2014/02/08/decide-responsive-website-native-mobile-app/
* http://mobiledevices.about.com/od/additionalresources/a/Native-Apps-Vs-Web-Apps-Which-Is-The-Better-Choice.htm
* http://sixrevisions.com/mobile/native-app-vs-mobile-web-app-comparison/
 
 
The native app will work locally on the device and will not be required to interact with live data. Certain aspects of the interaction can be simple listings but this information should be public information. A native app will require communication with an intermediate communications application as direct contact between bxp and the app could not be easily IP address locked.
 
A portal app is a redirect to an app aware and enabled web page. This enabled website is what will communicate directly with bxp and control what functions the app will have access to.
 
 
 
== Computer Telephony Integration (CTI) ==
 
 
There are many instances where the phone system has valuable information. The incoming call will have the line the call came in on (DNIS), the callers number (CLID), the agent / extension the call was delivered to ( agentid / ext ) and if the call goes through an IVR a number of other key pieces of information can be gathered before it even gets to the agent.
 
 
Often these solutions have the ability to open a web page and pass information via the querystring. For this reason the phone system may not be able to POST to bxp but can pass information via the querystring.
 
 
The most common function for this in the API is 7.3.5 Login + Data Management + Data Logging. This allows for a number of parameters to be passed in and the
 
 
<syntaxhighlight lang="php" line start="2">
https://ww3.allnone.ie/client/client_demo/cti/userCTI_GenericEntry.asp?system=datalogging&user_id=abc123&user_key=passkey&campaign_code=CODE_001&parameterA=passedDataA&parameterB=passedDataB
</syntaxhighlight>
 
 
Each of the parameters can be read in and logged in specific fields. The form can then also be extended using AJAX to perform a LiveSearch to see if the customer has other cases or records in the system.
 
 
 
== 3rd Party Software Integration ==
 
 
It is also possible to integrate bxp into other applications. Using the same POST and querystring approach, bxp can be built into any SDK environment.
 
* ASP: demonstrated in the BEAPI
* ASP.Net: http://msdn.microsoft.com/en-us/library/debx8sh9.aspx
* C: http://www.linuxquestions.org/questions/programming-9/how-can-i-post-data-with-post-method-in-c-programming-542700/
* C++: http://stackoverflow.com/questions/1011339/how-do-you-make-a-http-request-with-c
* C#: http://stackoverflow.com/questions/5401501/how-to-post-data-to-specific-url-using-webclient-in-c-sharp
* Java: http://stackoverflow.com/questions/4205980/java-sending-http-parameters-via-post-method-easily
* Objective C: http://stackoverflow.com/questions/15749486/sending-an-http-post-request-on-ios
* PHP: demonstrated in the BEAPI
7,528
edits