Adobe Community: Message List - API/ 3rd Party Integration

Re: Hot to update the subscription details of an user using the Web Service (API)

forums_noreply@adobe.com — Fri, 24 Oct 2014 03:37:40 GMT

There is no API to do this currently. There is a NEW API for the v3 api coming soon but it isn't available to external apps and currently that also does not have this feature.

At this stage - it is not possible without writing a ghost bot and running that on a server to log in and do the commands - and that is far from ideal.

Hot to update the subscription details of an user using the Web Service (API)

forums_noreply@adobe.com — Thu, 23 Oct 2014 13:16:48 GMT

Hello,

I'm working integrating a BC site, with an external CRM system. It works, but my customer needs to update not only the contact information, but also the discounts % found in the subscription tab of the CRM of each user.

I can't find any specific method of the web service to manipulate any subscription parameter. Is something yet to be implemented on the BC side?

Thank you in advance.

Fabrizio

Re: Interface with Xero Accounting Software

forums_noreply@adobe.com — Thu, 23 Oct 2014 02:37:00 GMT

I concur with FitzroyIT's comment. I'd be interested to hear if you had any luck with your Xero intergration? I'm also left out in the dark without onesaas and don't have the budget to have a solution custom-built.

Cheers

Re: Real Estate external XML data

forums_noreply@adobe.com — Tue, 14 Oct 2014 23:42:11 GMT

What ended up being your solution? I have a similar project using BDX.

Re: Interface with Xero Accounting Software

forums_noreply@adobe.com — Mon, 06 Oct 2014 23:25:15 GMT

Hi Patrick,

Just wondering if you had any success with your Xero integration? I'm looking to implement the same thing and would love to be pointed in the right direction.

Onesaas are currently redeveloping their method, so that is not an option at the moment.

Cheers

Re: Is it possible to automate tracking info from a local db to bc?

forums_noreply@adobe.com — Mon, 06 Oct 2014 01:20:29 GMT

Sure thing, I'll PM you my contact details or feel free to contact me on private message anytime.

Re: Is it possible to automate tracking info from a local db to bc?

forums_noreply@adobe.com — Sat, 04 Oct 2014 20:50:41 GMT

hey BcMan, thanks for this. I know it's a bit late in the reply, but I am not ready to implement this. Can I contact you in the near future when our relaunch is happening?

Thanks again,

Spookie

Re: Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Thu, 02 Oct 2014 00:54:57 GMT

Can anyone from BC staff chime in on this, I worked around my issue by disabling shipping and getting the users email address on the input user details page but it limits what I can do to the user mid session.

Re: Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Thu, 25 Sep 2014 02:15:48 GMT

Yep already thought of that, but forcing or hacking a user (AJAX) though a form is not nice, I still need an email address to make the entity ID, so I would have to make fake email address' for them, the CRM would fill up with crap entries, I then could track those fake CRM users and delete them on a cron cycle or something like that but it would mess up the use of the CRM because they would be viable in reports.

I could also ask them what their email address is on checkout then create the entity ID (or look it up) in the CRM via API but I would have to do that on the shopping cart checkout page as I couldn't get a confirmation page without selecting shipping, it is just not a nice user experience to ask, what is your shipping details and your email address on the cart checkout.

All could be avoided if you could update the shopping cart via the order ID only just like BC does on the website.

Re: Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Thu, 25 Sep 2014 01:58:32 GMT

They are until they purchase, and as you noted if you got a cookie then it re-uses it.

I would actually like BC to generate it as soon as they hit the site. You get the entity ID as soon as you finish a web form, you can dump the module tag on a confirmation page and you can see it generated on the front end.

My point was that your a person (entity) on BC so everyone is an entity and an order at least needs to be associated with a general nobody which is -1 currently or an active entity ID. You can pass that on a site to API service to then do stuff in the background. Jason T at Simpleflame does this for example with several cool implementations they have done in the passed.

So...

- Someone on the site = -1

- Some form of interaction - Entity ID - not in the CRM - There are cases of this but I do not have a full list of cases - would be nice

- Done something on the site like fill in a form - Entity ID - Now in the CRM so that is the customer ID.

On my testing I have have been on the cart with entity id not -1 but not in the CRM but I can not work out what use case this is.

I am not saying things are ideal or anything, Just noting what I know of it, and as mentioned, we would like this to be an assigned value as soon as you hit a BC site and then accessible via liquid along with some session info for better digital marketing stuff.

And as the last note - All the API is being done and sorted into REST etc, so the SOAP stuff wont be updated again now but we will have access to new stuff at some point not to far away - BC has not given a full ETA.

Re: Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Thu, 25 Sep 2014 01:45:01 GMT

Thanks for info, orders for users not logged in have entity ID's of -1, so they might have a cookie with an entity ID but the API / database certainly doesn't know about it and is going off the order ID. If the entity ID is created first time you hit the site in my investigation the VID cookie is empty or contains the number 0. When is the entity ID assigned to a brand spanking new user? If I assign that new entity ID to the order and the user logs in there order will disappear unless I detect the login and then reassign the order to the new entity ID?

Re: Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Wed, 24 Sep 2014 08:41:14 GMT

Order ID needs to be assigned to a CRM entry. An existing customer has their ID, a new user is assigned one. When you hit the site your assigned an Entity ID. So you just checking out or the instant you add to cart and generate an order that needs to be associated to something.. Which is the Entity - You can consider this as the person on the site.

With one of our near completed apps we have a live order status feed with lots of information, current shoppers and their cart etc. Entity ID for me is a key feature and something we even want expanded on and accessible with liquid.

Required entity ID for Order_CreateUpdate

forums_noreply@adobe.com — Wed, 24 Sep 2014 08:25:28 GMT

Is there any reason why Order_CreateUpdate API called MUST have an entity ID to update? Why can't we update "yet to checkout customers" with entity ID's of -1 and only update customers that are logged in or already checked out and paid for? Or is there any other way to update an uncompleted order via the API?

This API call should only be tied to the order ID and nothing else.

Any APIs for mobile applications to connect with BC database

forums_noreply@adobe.com — Fri, 05 Sep 2014 03:26:01 GMT

Hi everyone,

Can anyone guide me on how to use BC sign-in feature from 3rd party mobile application ?

For ex: I want to make a user logged in through my mobile application by sending username and password in http request. Is there a way of getting that done ? Has BC exposed any API to get that done ?

Also is there a way of fetching the user's favorite list and adding things to favorite list from mobile application ?

Any help in this regard is highly appreciated.

Thanks.

Re: Create New or Update CRM Customer via API

forums_noreply@adobe.com — Thu, 04 Sep 2014 16:53:36 GMT

Thanks Liam

Re: Create New or Update CRM Customer via API

forums_noreply@adobe.com — Wed, 03 Sep 2014 22:25:31 GMT

Hi there,

1. The account that has API permissions is the username and password. SiteID is under the > Settings > API in the admin.

2. You use another api endpoint to check if email exists, if not then add it in using that api endpoint.

Create New or Update CRM Customer via API

forums_noreply@adobe.com — Wed, 03 Sep 2014 20:44:36 GMT

I need to start by saying I know NOTHING about API / 3rd party integration.

Is it possible to update or add a new CRM customer from with the API?

I gave my contact at the 3rd party i'm working with a link to the API documentation and he responded with the following.

"I do not see anything to create a contact. The only thing that is close is ContactList_UpdateInsert web service. I want to try this one to see if it will add a contact if it does not already exist. For me to try this, I will need the web service username, password, and siteId"

This leaves me with two questions.

Where do i find the web service username, password, and siteId?
Is what i'm trying to do with customers possible?

Any help would be great!

Real Estate Listings

forums_noreply@adobe.com — Sun, 31 Aug 2014 16:38:50 GMT

Hello all.

Wondering if anyone out there has successfully integrated a real estate listing system (MLS or Realtor.ca or similar) into a BC site?

I am building a site and looking for any help/suggestions to integrate external listing data into a BC site.

Has anyone had any luck with API integration or third party API systems?

Any suggestions would be so helpful!

Thanks

Re: Create products through APIs

forums_noreply@adobe.com — Fri, 29 Aug 2014 22:53:16 GMT

Hey there,

This: Developer reference

Create products through APIs

forums_noreply@adobe.com — Fri, 29 Aug 2014 20:32:14 GMT

Trying to insert a product to BC, using APIs, I need to find the APIs that allows me to insert a product to a category with all attributes, and inventory. I keep ending up to this page: https://worldsecuresystems.com/catalystwebservice/catalystecommercewebservice.asmx which is only for retrieving . Where are the insert or create APIs documentations? how can I create a product by APIs ?

Re: Support of vr pay virtuell by business catalyst?

forums_noreply@adobe.com — Wed, 20 Aug 2014 04:07:23 GMT

If you want to do a payment that is not supported by BC you have to implement it yourself as Liam has suggested. The case study link is a good start, I've actually built this for a customer in the real world but you can't apply discount codes via the API (at this point in time) so it's better to do it via AJAX / JSONP and keep "most" of the frontend (and discount codes) on BC while the "processing" is done with another server and the API.

Re: Support of vr pay virtuell by business catalyst?

forums_noreply@adobe.com — Thu, 14 Aug 2014 11:11:15 GMT

Hi Tobias,

If it is not in the BC payment gateway list it is not supported. You will have to go through a 3rd party, like that of the two blokes:

Postie Blog - Integrate any Payment Gateway with Business Catalyst via API (A Case Study)

Support of vr pay virtuell by business catalyst?

forums_noreply@adobe.com — Thu, 14 Aug 2014 09:44:02 GMT

Hello everybody,

we would like to use http://www.vr-epay.info/?sub=API-VRPAYPAGE within business catalyst. However, there is no ready-to-use template in it. Has anyone tried to work with this payment system before?

Many thanks in advance for your support - and sorry for pointing to german website with the tecnical details.

Best,

Tobias

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 01:22:36 GMT

Adam,

API will have overhead and you'll need to process the result yourself to display, but assume that BC also has to do the same thing with ajax calls. One would also assume that any good programmer would reuse code on the backend therefore most of the calls on the server side BC code to the databases (that Adobe have coded) should be the using the same queries / functions, it would all come down to the overhead between and processing getting it to the screen.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 00:51:33 GMT

Thanks. That's good info.

Just occurred to me that the ultimate fast way of retrieving data in an app is just to render it on the page as a hidden JavaScript object. At least for initial data requests. I've done this several times on the front end, but there is always an inherent risk of users accessing sensitive data by looking at your source, which is why I started using web app searches instead. However, with an app, that isn't an issue at all.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 00:43:24 GMT

Ajax search of web apps below 800 - fine, if above then you wont return all results and have pagination so will miss out some results if they are big searches. Web app data pull will be similar but return all results better. Your web app search will be based on the layout you choose so the results would be pre-formated html based on a layout. Your API results will be the json response data of the whole thing you will then need to pluck out and form a rendered layout with or work with.

Depends on what you want to use the data for.

If it is to work out more calculations with your scripting then the API way would be the best but if your just wanting results and to display, the ajax would be the quicker method in general, not nessarily with the post but when you factor in everything.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 00:15:26 GMT

Well...I get the native first part, but an Ajax web app search is pretty similar in execution to an API request. Both require the server to return a live result as well. Perhaps, though, the search requires extra server-side steps to deliver the results.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 00:10:17 GMT

Native first, script second, api third is the rule I run on.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Thu, 14 Aug 2014 00:01:40 GMT

yep.

Re: What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Wed, 13 Aug 2014 23:59:42 GMT

In terms of an app Adam?

What's faster: API request or web app search via Ajax?

forums_noreply@adobe.com — Wed, 13 Aug 2014 23:50:37 GMT

Just curious, since I use both a lot. Assume there are a lot of records to retrieve.

Re: Single Sign-On intergration with 3rd party website portal

forums_noreply@adobe.com — Mon, 11 Aug 2014 14:52:18 GMT

thanks BC man. Unfortunately, BC couldn't be the master and while the 3rd party had a lot of open abilities, BC just didn't make a good fit on this one.

Re: Integrate Google Calendar API with Business Catalyst

forums_noreply@adobe.com — Sat, 02 Aug 2014 12:30:24 GMT

Credit goes to Mario for this post here: Display an external RSS feed in BC? which ended up providing the solution to my problem.

You can display public Google Calendar info via RSS by going to Settings > Shared: Edit Settings (under the Sharing column) > Calendar Details tab > Calendar Address (click on the XML icon)

This will provide a feed address which can then be displayed using zRSSFeed as per Mario's post.

Re: bugs in BC CRM web service need to be fix (Server was unable to process request ERROR: A server error has occured)

forums_noreply@adobe.com — Tue, 29 Jul 2014 04:12:07 GMT

Yes the sample is wrong, this documentation is all new previous to this it was a trial an error experience... I just use the samples from the methods page.

CatalystCRMWebservice Web Service

Re: bugs in BC CRM web service need to be fix (Server was unable to process request ERROR: A server error has occured)

forums_noreply@adobe.com — Tue, 29 Jul 2014 03:06:54 GMT

Perhaps it would be good to update the sample request as shown on the Developer reference page for this method (and, actually ALL of the SOAP samples)

The sample shows siteid (all lower case)

Re: bugs in BC CRM web service need to be fix (Server was unable to process request ERROR: A server error has occured)

forums_noreply@adobe.com — Mon, 28 Jul 2014 08:04:08 GMT

The API XML is case sensitive, note the caps on the I in ID and your code.

bugs in BC CRM web service need to be fix (Server was unable to process request ERROR: A server error has occured)

forums_noreply@adobe.com — Sat, 19 Jul 2014 03:48:38 GMT

I'm using the following code to retrieve order list is working fine but it give me an error Server was unable to process request ERROR: A server error has occurred when I trying to retrieve order total paid with same code: and the output when retrieve order total paid is [object Object]

var wsUrl = "https://mysite.worldsecuresystems.com/CatalystWebService/CatalystCRMWebservice.asmx?WSDL";

var RetrieveTotalPaidXML =

'<?xml version="1.0" encoding="utf-8"?>\

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" \

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">\

<soap12:Body>\

<Order_RetrieveTotalPaid xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">\

<username>user</username>\

<password>pass</password>\

<siteid>111222</siteid>\

<orderId>112345</orderId>\

</Order_RetrieveTotalPaid>\

</soap12:Body>\

</soap12:Envelope>';

$.ajax({

type: "POST",

url: wsUrl,

Host: "mysite.worldsecuresystems.com",

contentType: "application/soap+xml; charset=utf-8",

data: RetrieveTotalPaidXML,

dataType: "xml",

success: processSuccess,

error: function(){alert("Error: Something went wrong");}

});

function processSuccess(ResData) {

var RetrieveTotalPaidParse = $.parseXML(ResData);

var $xmlRetrieveTotalPaidParse = $(RetrieveTotalPaidParse);

var $Order_RetrieveTotalPaidResult = $xmlRetrieveTotalPaidParse.find('Order_RetrieveTotalPaidResult');

$Order_RetrieveTotalPaidResult = $(this).find('Order_RetrieveTotalPaidResult').text();

$('#RetrieveTotalPaidResult').text(Order_RetrieveTotalPaidResult);

}

I think there a bug in BC CRM Web Service when trying to make a request for Order_RetrieveTotalPaid using soap need to be fix

Re: Pull orders by date range

forums_noreply@adobe.com — Thu, 10 Jul 2014 01:34:31 GMT

You can't pull a date range but you can pull X records from a given start date all the while checking the date of each record to see if you are past the end date range that you are looking for.

Re: How to get all contacts base on a given email address

forums_noreply@adobe.com — Thu, 10 Jul 2014 01:32:27 GMT

BC doesn't work that way, basically an email address is the primary key for each entity in the CRM.

Re: API Suggestion: More country specific shipping options

forums_noreply@adobe.com — Tue, 08 Jul 2014 01:39:38 GMT

+ 1 for Canada Post integration

Re: Google Merchant feed

forums_noreply@adobe.com — Mon, 30 Jun 2014 23:30:11 GMT

A little late to the party but it's quite straight forward to do. To automate it API sync to your products, get the quality, photos and everything, you sync the products every 10 days or go with google, I've done it for a few sites.

You need A TON of information to submit to google, for example bar codes, product ID's, manufacture names, very very detailed. More than 50% of the work is getting the all product information sorted out.

Re: Has anyone integrated a learning management platform with BC?

forums_noreply@adobe.com — Mon, 30 Jun 2014 11:28:31 GMT

Take a look at bcgurus.com site, it is a good example of a learning website and I think they can help you achieve what you want to do.

Re: Use api from phonegap

forums_noreply@adobe.com — Mon, 30 Jun 2014 02:46:55 GMT

Sure thing, phonegap is basically Javascript so just use a Javascript SOAP lib to talk to the webservices API.

Here is something I found on a google search:

javascript - Simplest SOAP example - Stack Overflow

If you have any other questions just let me know.

Re: Single Sign-On intergration with 3rd party website portal

forums_noreply@adobe.com — Mon, 30 Jun 2014 02:43:30 GMT

There is no out of the box solution but it could be done via in a few ways, it would all depend on what the "membersuite member management website portal" could do. The BC database would have to be the master database in terms of username and password as there is no way to log someone in via an API, depending on how the other software is setup and what sort of output it could give and how it's authentication system worked, can you provide more info?

Re: Has anyone integrated a learning management platform with BC?

forums_noreply@adobe.com — Mon, 30 Jun 2014 02:36:24 GMT

Google analytics can handle most of that, just setup goals.

Re: Is it possible to automate tracking info from a local db to bc?

forums_noreply@adobe.com — Mon, 30 Jun 2014 02:30:09 GMT

Spookie,

You can update an order or CRM form (attached to order) via the webservices API, you can send any and all the data you need. You'll have to setup a system a middle man server (or use your existing backend) to download the order and match it to the BC order and on a timer or when the data is available from your other system update the order on BC. I've done this with for a customer and Fedex to give real time tracking numbers within 1 min of the order placed.

Integrate Google Calendar API with Business Catalyst

forums_noreply@adobe.com — Tue, 10 Jun 2014 08:35:24 GMT

Hi there,

I don't think this can be done but thought I'd ask here before throwing in the towel.

I have a client website that uses an embedded Google Calendar. Uses iframe, works great, no issues.

The client (a school) would like to display a list of upcoming events for the year (term dates, holidays, important events, etc), using info from the Google Calendar (which we input in the Google Apps end).

I've looked at the "Agenda View" (Change calendar views - Calendar Help) but it is too inflexible to accomplish what I'm wanting. I've also tried FullCalendar (FullCalendar - Full-sized Calendar jQuery Plugin) and this also insufficient for what we're trying to do. I've also looked into is parsing the Google Calendar RSS feed as a list of events, but I believe I need access to server-side code for this.

I'm sure the Google Calendar API will enable me to do everything I want but my understanding is that it relies on being able to access server-side code which of course isn't possible with BC.

Has anyone found any way to integrate the Google Calendar API, or have any workarounds, suggestions, etc, that I haven't already covered?

Thanks in advance for your time and help.

Luke

Is it possible to automate tracking info from a local db to bc?

forums_noreply@adobe.com — Thu, 05 Jun 2014 23:27:53 GMT

I would love to automate our AWB and TRACKING URL from our local database into BC.

Is there a method of doing this using WebServices?

I want to send three values to BC - invoice #, AWB, and tracking URL.

Any recommendations or case studies?

much appreciated, thanks!

Re: Google Merchant feed

forums_noreply@adobe.com — Fri, 30 May 2014 02:32:47 GMT

If you would like to get it sooner please contact brett [AT] prettypollution.com.au and let him know you have spoke to me and interested in getting the Feed.

There is some setup in terms of sorting products for google to be happy and also setting up the google side of things. Pretty are registered google partners so we can also quote time to help set all this up as well for you.

Re: Google Merchant feed

forums_noreply@adobe.com — Wed, 28 May 2014 22:33:00 GMT

Fantastic Liam. I would love to hear about this when you have it up and running.