developer_guide:field_reference:start
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
developer_guide:field_reference:start [2009/08/04 18:47] – matt | developer_guide:field_reference:start [2012/03/25 19:05] (current) – [Data Types] earlyimpact | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== API Field Reference ====== | ====== API Field Reference ====== | ||
+ | |||
+ | |||
+ | |||
===== Overview ===== | ===== Overview ===== | ||
+ | |||
The API Field Reference contains a list of all the XML elements you will encounter in the API. Additionally, | The API Field Reference contains a list of all the XML elements you will encounter in the API. Additionally, | ||
+ | |||
+ | |||
===== Elements ===== | ===== Elements ===== | ||
+ | |||
+ | |||
==== Username ==== | ==== Username ==== | ||
+ | |||
The Username is part of your API Credentials. | The Username is part of your API Credentials. | ||
+ | |||
+ | |||
+ | |||
==== Token ==== | ==== Token ==== | ||
- | The Token is a SHA hash made from your password and the current time. | + | |
+ | The Token is a HMAC/SHA hash made from your password and the current time separated by a pipe character. | ||
+ | |||
+ | The format of the token before encryption is as follows: | ||
+ | |||
+ | * The first part " | ||
+ | * The second " | ||
+ | * The third " | ||
+ | |||
+ | After you form the token you must encrypt it using HMAC/ | ||
===== Data Types ===== | ===== Data Types ===== | ||
- | ^ Name ^ Meaning ^ | + | ^ Name ^ Meaning ^ |
- | | string | alphanumeric characters | | + | | string | alphanumeric characters | |
- | | datetime | SB datatime format | | + | | datetime | SB datatime format | |
developer_guide/field_reference/start.1249426067.txt.gz · Last modified: 2009/08/16 00:00 (external edit)