A Beefed-Up API Section

API documentation has always been one of Akamai's strengths; in fact, the primary impetus behind the old Janrain docs site was to make sure we had a way to get API documentation out to customers and potential customers. That means that a lot of people have spent a lot of time on our API documentation, which, in turn, leads to an obvious question: how in the world could the Education Center improve on that? To answer that, just keep reading.

More Code Samples

Although people like to say that "More is always better than less," that's not always the case. More coughing and sneezing than less coughing and sneezing? No thanks. More pain in your ankle after twisting it than less pain in your ankle after twisting it? I don't think so. More – well, you fill in any analogy you like. More meetings, more dentist appointments, more traffic jams: the list goes on and on. 

However, there is one part of life where more is always better than less: code samples. (Why? What were you thinking?) There might be a limit at some point but, for the most part, having more code samples is better than having less code samples. It's a basic fact of life.

And, in the old docs site, it was also a problem from time-to-time. For the most part, our API endpoints all included code samples. Sadly, however, "most" does not mean "all." For example, here's our code sample for the /config/{app}/flows endpoint:

And no, that's not a misprint. We just didn't have a code sample for that endpoint.

In the Education Center, we're to provide code samples for all our API endpoints. Remember the old site's code sample for the /config/{app}/flows endpoint, the code sample that didn't actually exist? Well, here's the Education Center's code sample for that same endpoint:

Yeah, we kinda liked that one better ourselves.

Copy to the Clipboard

Websites that include code samples typically include a Copy to Clipboard button as well: when you click that button, it copies the code sample to your computer clipboard. It's a pretty simple concept and, like we said, many (if not most)websites that have code samples also have a Copy to Clipboard button.

The old docs site did not include a Copy to Clipboard button.

But that's not true for the Education Center. In fact, and by amazing coincidence, we just happened to have a code sample right here. And guess what? It's accompanied by – drumroll please – a Copy to Clipboard button:

curl -X get \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows \
  -H 'Authorization: Basic dXQ0YmdycmE3dzI4MmpjZm15cGZxeDlwemhxaGpqMmI6eXk4MmhxdXhnbWt6bWMzcGRoZ3VmdDNwNHluc3R6cjU=' \

Please hold your applause until the end.

Incidentally, the button above actually works: if you click it the code sample will be copied to the clipboard. And what do you do after that? Well, here's a thought: why not paste it into the empty text field below (funny how we also happened to have one of those lying around)? That way, you can verify that the button actually does what it's supposed to do:

What did we tell you?

New Postman Collection

If you're like millions of people (including many of us at Akamai) you turn to Postman any time you want to make an API call (you also to turn to Postman any time you want to investigate a new set of APIs). And if you're familiar with Postman then you're probably also familiar with Postman collections, a handy way of bundling all your API endpoints into a nice, neat, and extremely easy-to-use little package. 

Well, if you like Postman and if you like the Akamai REST APIs, then you'll love this: the Education Center lets you download a brand-new, and fully-stocked, Janrain Postman collection. It's just our way of saying, "Thanks for being a Janrain customer." 

OK, technically we created it for our own use, and only later decided to make it available to everyone else. But you don't need to know that.