Project

General

Profile

General Notes » History » Version 29

Version 28 (Seulki Lee, 01/03/2014 09:15 AM) → Version 29/40 (Redmine Admin, 02/05/2014 11:01 AM)

h1. General Notes

h2. API Base URL

<pre>https://api.bricklink.com/api/store/v1</pre>

h2. SSL only

We require that all requests are done over SSL.

h2. UTF-8 encoding

Every string passed to and from the Bricklink API needs to be UTF-8 encoded.

h2. Date format

All timestamps in the API are strings in "ISO 8601":http://en.wikipedia.org/wiki/ISO_8601 format:
<pre>
yyyy-MM-dd'T'HH:mm:ss.SSSZ
2013-12-01T18:05:46.123Z
</pre>

h2. Rounding policy

For all financial calculations, BrickLink API uses values with 4 decimal places. Any values that has greater precision will be rounded up to the 4 places.



h2. Base URL

All URLs referenced in the documentation have the following base:
* Before "going live", use [[BLAPI_Sandbox|sandbox URL]] instead.

h2. Request

* [[Authorization|OAuth parameters]] should be included in every request.
* In the PUT or POST, you represent the resource object you wish to update as form of urlencoded JSON.
* Optional parameters (ex pagination info) should be provided as query string with urlencoded form.

h2. Response

BrickLink API supports returning resource representations as JSON with the following structure:

|_. Property Name |_. Value |_. Description |_. Notes |
| meta | Object | Extra information about the response | |
| meta.code | Integer | API result code. (2xx if successful, any other number otherwise) | [[Error_Handling#Result-Code|Result Code]]|
| meta.message | String | More granular information about the result | |
| meta.description | String | Detailed description of the result | |
| data | Object | Requested information. Depending on the type of request you made, the HTTP response message body may be empty (typically for DELETE messages), but if the body is not empty, it will always be JSON object. | |

<pre>
<code class="json">
{
"code":"200",
"message":"OK",
"description":"OK",
"data": {

}
}</code>
</pre>
Add picture from clipboard (Maximum size: 24.4 MB)