6 Examples of What’s Possible with the Articulate Online API

Apr242009
Written by Gabe Anderson — Posted in Articulate Online

Articulate Online

Update (July 25, 2017): Please refer to the Articulate Online API Examples GitHub repository for updated information. The below info is archived for reference, but mostly outdated.


It’s been a few months since we first announced the Articulate Online API, and we’ve already begun to see some examples of what’s possible with the API.

The Articulate Online (AO) API currently gives you the ability to manage users and groups, as well as content items (documents) in your account. You can see details of the current API calls here.

Examples of How to Leverage the Articulate Online API

How you leverage these calls in Web applications is up to you. Here are just a few examples — with code! — of what you can do with the AO API:

  1. Accept payment from PayPal: AO QA Lead Dave Mozealous has a detailed tutorial about how to accept payment via PayPal, then automatically create a new user in your AO account to access the content. You can even purchase a demo quiz from Dave via PayPal for $0.10.
  2. Create a self-registration page: Dave also outlines how to use the AO API to create a self-registration page. He even provides the sample code you can drop into your own website. And you can see it in action in this demo.
  3. Export all users to CSV: Dave provides another useful example of how to leverage the AO API by offering a PHP-based Web app to export all users in your AO account to CSV. You can plug in your own AO account details to see it in action here.
  4. Set up automatic login: Community Forums member kevinb wanted to be able to have his users automatically login to his Articulate Online account, so using the AO API, he wrote the code to do this in ASP. Learn more and download the ASP code in this forum post.
  5. List content items in your account: Kevin also wrote the sample ASP code for how to retrieve a list of all content items or documents in your Articulate Online account. You can also learn more in the same forum post.
  6. Integrate an e-commerce storefront: One of the most popular feature requests for AO is about integrating it with e-commerce. Using the AO API and working with an integration company like Trigent, you can make AO talk to your e-commerce store. Read on below for more…

Integrating Articulate Online & E-Commerce

If you already have an e-commerce solution or are looking for one to integrate with your Articulate Online account, a company like Trigent can help you do this via the AO API.

Here are some resources to get you started with Trigent:

A Customer Success Story

Articulate customer Jaspersoft creates elearning with Articulate tools and wanted a way to sell its training courses via Articulate Online.

The company engaged Trigent to make its e-commerce store talk to its Articulate Online account with the AO API.

The result is a hassle-free integration that allows Jaspersoft customers to purchase online training courses — right through its website — then have their Articulate Online accounts automatically created.

“The use of the AO API has seamlessly integrated our Ultracart online store with Articulate Online, where automated account provisioning takes place for our web-based training courses. The AO team contributed significantly, assisting our team with timely and accurate technical support. The success of our online store integration with Articulate helps support our goal to deliver a rich self-service online environment for a large and growing Jaspersoft developer community.”
– Tom Vu, Manager of Web and Systems

Get the Articulate Online API

The Articulate Online API is available now. There is an additional fee to activate API support in your account, and you can contact your sales representative to learn more. As of Novmber 2014, the API is now included with all Articulate Online plans.

20 responses to “6 Examples of What’s Possible with the Articulate Online API”

1

Hi Gabe,

Excellent post. Very helpful and the timing is perfect as I am just about to hire a firm to create a site that delivers training courses (made with Articulate, of course) and certification (determined by passing quizmaker tests) through AO. I have been looking into the API and need exactly the same thing as Jaspersoft.

Additionally, I’d like a few other features. Does the AO API allow the following? If not, is a firm like Trigent allowed to further develop the API so it does?

1. Branding customization beyond just adding a logo. Ideally, I would like to adjust the CSS and launch AO framelessly from within my site.

2. Allow for the sending of a pass or fail quiz result to my CMS site. Upon passing, i would like a customer profile (filled with their AO user info) to appear publicly in a certification directory.

Thanks again!

Best…
Clint

Clint Fuhs // Posted at 8:51 pm on April 24th, 2009
2

Hi Clint- Glad to hear the timing is good and that this will help you out!

As for your questions:

1. No, this is not possible via the AO API. The API is about data exchange, not design modifications. However, just to clarify: The only Articulate Online branding you should see is in the admin interface. Your user-facing content can be designed however you’d like, so when users launch content created, for example, in Articulate Presenter, it can have your own branding. Where are you looking to have your own branding?

2. The API does not currently support passing of results to another system.

For both suggestions, though, I’d encourage you to share your feedback (and any other ideas) via our feature request form.

gabe // Posted at 10:43 am on April 27th, 2009
3

Hi – the ability to export users to a CSV is very nice – but what about the other way: is it possible to upload a list os users via a CSV (this list of users would come from an existing database)? Also, with this list, I would like to have some kind of authentication, so that if this is first time a user is using the AO, I want the user to get some kind of confirmation window that they agree to pay for using my AO, and if they agree, I want some kind of email to be sent to our Finance dept who will then take care of sending them a PO…I hope this makes sense, and I hope you might say that it is all possible…

Sam

Sam Kamin // Posted at 8:43 am on May 18th, 2009
4

Hi Sam,

Yeah, doing something like this would be possible with Articulate Online’s API feature. We have a CreateUser function that would be able to automatically create the users. You would just need to build the parts like the confirmation page, and emailing to Finance. But the other parts on the AO side are all possible.

Dave Mozealous // Posted at 11:13 am on May 18th, 2009
5

Thank you very much Dave!

What about incorporating additional search capabilities into Articulate Online, besides the tags? The tags are nice, but it would be nice to have a more powerful search capability…is there something like that, or can it be added?

Thank you for all of your help!

Sam

Sam Kamin // Posted at 1:22 am on May 19th, 2009
6

Hi Sam- The best place to direct product feedback and feature suggestions like this is our feature request form. That will make sure our product management team sees your suggestion.

gabe // Posted at 7:58 am on May 19th, 2009
7

Also Sam, you could build your own search function using the API if you wished. It wouldn’t appear in Articulate Online itself, but could be used externally.

Dave Mozealous // Posted at 8:37 am on May 19th, 2009
8

Within a year of using the AO API and Articulate Online platform to server our web based training courses, we’ve been able to augment our traction and awareness of our product line for the open source community, while also helping to reinforce product adoption and expert use of our solutions to our enterprise customers. The use of AO API and Articulate Online has offered interactive web based learning to our thousands of developers and users of our BI software. Thanks again!!!

Tom Vu // Posted at 8:09 pm on February 11th, 2010
9

Is there a separate cost for the AO API? How does that work?

Bob // Posted at 11:11 am on December 11th, 2010
10

Hi Bob- the API is included at no cost with the Articulate Online Premium plan or higher. There is a one-time cost to activate it on lower-level plans, and you can contact your account manager to discuss details.

gabe // Posted at 10:40 am on December 13th, 2010
11

We have a custom learning environment in Moodle, where we post Articulate presentations that are published as LMS.

With Articulate Online, would we be able to post lessons on our Moodle environment and also track user scores for quizzes? Does the API allow us to have this functionality? We want to see how our trainees are doing in the quizzes.

Any information would be much appreciated.

Thanks,

Deniz

Deniz // Posted at 3:40 pm on February 2nd, 2012
12

@Deniz: Thanks for asking. If you already use Moodle, then why would you want to use Articulate Online? Typically customers use one or the other system. Not sure I understand that, since they offer similar functionality.

Regardless, the Articulate Online API does not currently offer a call to extract reporting data from your account.

gabe // Posted at 11:29 am on February 3rd, 2012
13

Hi,

We have a requirement to keep a track of the CPD Timer values in our custom shell on LMS. Is there any provision to set and get the bookmark values? If yes please guide me how to proceed.

Thanks,
Garima

Garima // Posted at 4:47 am on February 9th, 2012
14

Hi Garima. We send bookmarking information via the suspend_data that is sent when communicating with an LMS.

Justin Wilcox // Posted at 9:29 am on February 13th, 2012
15

Hi Justin,

Thanks for your reply. Could you please also tell me if there are any methods available in the API to get/set the suspend_data?

Thanks,
Garima

Garima // Posted at 3:36 am on February 14th, 2012
16

You need to publish for LMS as noted here:
http://www.articulate.com/blog/publish-to-lms-with-studio-09/

We send the suspend_data when the content is communicating with the LMS.

Justin Wilcox // Posted at 10:20 am on February 14th, 2012
17

Hi Garima,

Currently there are not any methods available for setting/getting the suspend_data.

-Dave

Dave Mozealous // Posted at 10:22 am on February 14th, 2012
18

Hi Justin, Thanks for sharing the link.
Actually we have a custom shell that requires suspend_data customisation. Thanks, but it couldn’t be of much help.

Hi Dave, Thanks for your support. Will see if there’s any workaround.

Thanks,
Garima

Garima // Posted at 4:50 am on February 15th, 2012
19

Hi Gabe
I just got access to the Articulate Online API and trying to follow http://www.mozealous.com/ao-api-samples/
I built my company website using Shopify and I was wondering if it is possible to integrate the API with Shopify.
Kind regards,
Oscar.

Oscar // Posted at 4:32 pm on February 6th, 2014
20

@Oscar: I’m not familiar with Shopify, but I’d suggest posting your question in our Articulate Online community forum.

Gabe Anderson // Posted at 5:23 pm on February 12th, 2014

Comments are closed on this post. Need more help? Post your question in the E-Learning Heroes Discussions.

Recent Comments