Encode a URL in Node.js with a Utility Choreo


Temboo does lots more than just work with APIs. We've got a growing collection of programming utilities that will make your life much easier. In this tutorial we'll show you how to use these handy code shortcuts by working through a URL encoding example.

You might ask "why is URL encoding important?". Well, URLs can only be sent over the Internet using the ASCII character-set. Since URLs often contain non-ASCII characters, they need to be converted so they only contain valid characters. The general rule is that unsafe characters are replaced with a % followed by two hexadecimal digits. Spaces are replaced by either a plus sign (+) or with %20. You've probably seen URLs full of strange looking characters, and now you know why!

The good news is that you don't actually have to worry about the specifics. Our URL encoding utility will do all the work for you.

Get Set Up

1 Log in to Temboo. If you don't already have an account, you can register for free.

2Make sure you've downloaded the Temboo Node.js SDK and that you've added it to your development environment as described in our Node.js getting started tutorial.

Test the Choreo

3Go to the Utilities > Encoding > URLEncode Choreo page. Select Node.js from the drop down menu at the top of the page.

4Enter some text that you want to URL encode. It should contain illegal characters, like spaces, accents, and punctuation. Here's some text you can use:

I'm Enc0ding URL$ wITh T3mBo0

5Click Generate Code to test the Choreo from our website, and you'll see the the URL encoded result returned by the Choreo.

Create Your Node.js Program

6To call the URL encoding Choreo from a Node.js program, copy the generated code from your browser directly into a Node.js class and try running it there. Your code should look something like this:

// You'll need a single TembooSession object in your code, eg:
var tsession = require("temboo/core/temboosession");
var session = new tsession.TembooSession("ACCOUNT_NAME", "APP_NAME", "APP_KEY");

var Utilities = require("temboo/Library/Utilities/Encoding");

var uRLEncodeChoreo = new Utilities.URLEncode(session);

// Instantiate and populate the input set for the choreo
var uRLEncodeInputs = uRLEncodeChoreo.newInputSet();

// Set inputs
uRLEncodeInputs.set_Text("I'm Enc0ding URL$ wITh T3mBo0");

// Run the choreo, specifying success and error callback handlers
uRLEncodeChoreo.execute(
    uRLEncodeInputs,
    function(results){console.log(results.get_URLEncodedText());},
    function(error){console.log(error.type); console.log(error.message);}
);

7Run the code and the URL encoded version of the text will be printed in the console.

What next?

We're all finished! Now your know about Temboo's range of handy developer utilities and how to access them via our Node.js SDK. These utilities will help you work with the 2000+ Choreos in our Library.

Once you've got your code up and running, you're ready to move on and do more. From monitoring your running applications, to moving your generated Temboo code to your preferred development environment and sharing it with colleagues, collaborators and friends - we've got you covered.

Need help?

We're always happy to help. Just email us at support@temboo.com, and we'll answer your questions.


Back