Understanding the Amazon CBUI Samples

Amazon provides five samples in four programming languages (C#, Java, Perl, and PHP) which show you how to build Co-Branded User Interface request URLs.

When you download a sample file, such as amazon-fps-2008-09-17-java-library, the [package root]/src/com/amazonaws/cbui/samples folder contains sample classes showing how to generate pipeline-specific CBUI URLs from your code ([package root] is the location you extracted your sample package).

Each sample describes its requirements in its Readme.html file, located at the package root. Typically, the entire library structure must be available to the compiler. For example, the amazon-fps-2008-09-17-php-library.zip file contains the src/Amazon/CBUI and folders which the files in src/Amazon/CBUI/Samples require.

In addition to these primary components, a sample may include other required resources. For example, the Java samples all include numerous jar files in the [package-root]/third-party folder, which must also be in your classpath in order to compile the sample.

For each sample, you must set your security credentials and Amazon FPS sandbox endpoints in a library-dependant way. For example, to use the C# library, you set your security credentials in the [package-root]/src/Amazon.FPS.Samples/Amazon.FPS.Samples/AmazonFPSSamples.cs file, while for the perl library you set them in the individual [package-root]/src/Amazon/CBUI/Samples/*.pl file you are working with.

The following samples are provided with each sample library:

In the following section, we show how to work with the CBUI Single Use Pipeline sample using the Java library. This sample enables you to set up a single-use token for a one-time payment. You will find that the basic process you use for the CBUI Single Use Pipeline sample is the same for all the other samples in the CBUI/Samples (or, in the case of Amazon.CBUI.Samples) folder. (The process for the FPS and Return URL/IPN Validations samples are different. For more information, see Understanding the Amazon FPS Samples.)

AmazonFPSSingleUsePipeline pipeline= new AmazonFPSSingleUsePipeline(accessKey, secretKey);

//pipeline name, your return URL, and the amount
pipeline.setMandatoryParameters("callerReferenceSingleUse", 
"[your returnUrl]", "5"); 

//optional parameters
pipeline.addParameter("currencyCode", "USD");
pipeline.addParameter("paymentReason", "Now and Forever - Richard Mark");
pipeline.addParameter("paymentMethod", "ABT,ACH,CC">;
pipeline.addParameter("callerReference", "[Unique ID for the transaction]");