Differences

This shows you the differences between two versions of the page.

--- developer_guide:field_reference:start [2009/08/04 18:40] – created matt
+++ developer_guide:field_reference:start [2012/03/25 19:05] (current) – [Data Types] earlyimpact
@@ Line 1: / Line 1: @@
-====== API Element Reference ======
+====== API Field Reference ======
+===== Overview =====
+The API Field Reference contains a list of all the XML elements you will encounter in the API.  Additionally, it define the different data types used in each of those elements.
+===== Elements =====
+==== Username ====
+The Username is part of your API Credentials.  This is not the Username you use to login to your Merchant Account.
+==== Token ====
+The Token is a HMAC/SHA hash made from your password and the current time separated by a pipe character.  By this method the token is time sensitive.  A token will remain valid for 2 minutes.  Your request must be made within two minutes after generating the token.
+The format of the token before encryption is as follows:  XVWWVPRGab|2010-07-16T06:52:00
+  * The first part "XVWWVPRGab" is the password.
+  * The second "|" is the pipe.
+  * The third "2010-07-16T06:52:00" is the timestamp. It is important to note that the seconds of the timestamp must always be "00". The time is GMT.  To obtain the exact timestamp you may call the [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]] method in the Subscription API.
+After you form the token you must encrypt it using HMAC/SHA.  You will find encryption samples for PHP, .NET, and Classic ASP in the samples section.
+===== Data Types =====
+^ Name ^ Meaning ^
+| string | alphanumeric characters |
+| datetime | SB datatime format |
-^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| Username| string | required | Merchant API username (this is not your SubscriptionBridge login id) |
-| Token| string | required | Your application's security token. view also: How to create a token |