PRX Builder API
Website Integration How-To

This is a simple step-by-step guide to integrating PRX Builder into your website using the PRX Builder API.

1. Obtain an API key

Every PRX Builder API application needs to obtain an API ‘key’. Contact support@prxbuilder.com to apply for a key.

2. Embed the code in a protected web page

When you use the PRX Builder API, you are bypassing PRX Builder’s normal login security.  The API is expecting one of your systems (e.g. Active Directory or a website login) to authenticate a user and then pass that authenticated user id into the api url.

Failure to properly authenticate a user before passing the user id can result in the revocation of your api_key.

Sample PHP Code

<?php
$api_key = ‘9a0554259914a86fb9e7eb014e4e5d52′;
$secret = ‘000005fab4534d05‘;
$method = ‘user.login.redirect’;
$userid = ‘jdoe@company.com;  //This value should be dynamic and come from your user management system.
$email = ‘jdoe@company.com’;  //This value should be dynamic and come from your user management system.
$api_sig = MD5($secret.’api_key’.$api_key.’email’.$email.’method’.$method.’userid’.$userid);

$url = ‘http://www.prxbuilder.com/api.aspx?method=’.$method.’&api_key=’.$api_key.’
&api_sig=’.$api_sig.’&userid=’.$userid.’&email=’.$email;

echo ‘<iframe src=”‘.$url.’” width=”685″ height=”2800″ frameborder=”0″ scrolling=”no”></iframe>’;

?>

Constructing PRX Builder’s API URL

Example URL:

http://prxbuilder.com/api.aspx?api_key=[api_key]&method=
user.login.redirect&userid=[user id]&email=[email]&api_sig=[api_sig]

[api_key] is the API key you created in step 1.

[user id] is a unique user id from your system (coded as an email address).

[email] is the email address to which the user would like to receive emailed releases.

[method] is the api method being called.

[api_sig] is a signature of all of the parameters except the api_sig. Signatures are created using your secret and the other arguments listed in alphabetical order, name then value. In our example, our API key is 9a0554259914a86fb9e7eb014e4e5d52, our shared secret is 000005fab4534d05 and we are calling the user.login.redirect method.

So our signature string is 000005fab4534d05api_key9a0554259914a86fb9e7eb014e4e5d52
emailjdoe@company.commethoduser.login.redirectuseridjdoe@company.com. This is secret + ‘api_key’ + [api_key] + 'email' + [user email] + 'method' + [method name] + ‘userid’ + [user id]. We then take the MD5 sum of the string - this is our [api_sig] value. We can then build our full login URL:

http://prxbuilder.com/api.aspx/?api_key=9a0554259914a86fb9e7eb014e4e5d52&method=user.login.redirect
&email=jdoe@company.com&userid=jdoe@company.com&api_sig=a02506b31c1cd46c2e0b6380fb94eb3d

releases.list

Returns a list of releases for a specified user.

Arguments

api_key (Required)

Your API application key.

method (Required)

releases.list 

userid (Required)

A PRX Builder user id.

status (Required)

Release status.  Possible values: ’draft’ or ‘published’.

api_sig (Required)

<files>
	<file modified="March 21, 2006" href="http://www.prxbuilder.com/link.aspx?
                       id=0e2738f2-1cda-2ccb-ae91-203901af391d&amp;name=myrelease.xml">
                myrelease.xml
	</file>
</files>