Anonymous, bureaucrat, administrator
7,528
edits
Changes
no edit summary
The BEAPI bxp api is a way for 3rd party systems to interact directly with the bxp software platform (bxp).
The formal API documentation is publicly available from [http[File://www.allnone.ie/whitepapers/BEAPI%20v5bxp_API_v6-10-03.pdf]]
'''Security Note:''' The BEAPI bxp api will not grant access by default. It requires EXPLICIT IP address declaration to grant any form of access or engage in any communication. The only exception to this rule is the IsAlive function which is globally accessible to see if the service is responsive.
The current version is '''56-10-03'''.
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 BEAPIbxp api
* 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/
* 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 BEAPIbxp api
The detailed setup on how to do this is explicitly detailed in the BEAPI bxp api document.
The summary is:
This is detailed in function 7.4.4 Website – Data Logging of the BEAPIbxp api
This is detailed in function 7.4.3 Website – Data Query of the BEAPIbxp api
'searchfield' => urlencode('intCDA_56_Id'),
'value' => urlencode('1'),
'strMatchingOptions' => urlencode('Bool'),
'responsefields' => urlencode('strCDA_56_field_1_5,strCDA_56_field_3_5')
);
* Line 12: user_id is the username of the account with permission to access the form as set up in steps 2.7 and 2.8 of this document
* Line 13: user_key is the password of the account with permission to access the form as set up in steps 2.7 and 2.8 of this document
* Line 14: strMatchingOptions is the type of value matching you wish to use, the following are the allowed types Exact matching, Like Matching and Boolean Matching. To use Exact Matching enter "Exact", to use Like Matching enter "Like" and to use Boolean Matching enter "Bool"* Line 15: system is the function to be used, in this case datasearch* Line 1516: campaignid is the Id of the form to be accessed. This Id is available from Main Menu > Data Profiilng> Instant - Dashboards > Form – Profile. * Line 1617: searchfield is the field to be listed against* Line 1718: value is the value to be listed against.* Line 1819: responsefields are the fields from the form that will be returned in the data file. The responsefields are separated by commas using fields from the Field Mapping list. '''Notes''' If you require to use the comma character in your search value you will be required to replace all comma's in your search value with the following '''[ [ [ [Comma]]]]'''
== Conclusion ==
The BEAPI bxp api make bxp software extremely accessible. The All n One development team are very comfortable in dealing with all your queries and providing potential solutions. If you prefer to use us we'll be happy to quote for whatever work you need. Please get in touch with us today to see how we can help you.
[[Category:Topic:bxp API]]
[[Category:Topic:Start Here]]