| POST | /v1/links | ||
|---|---|---|---|
| POST | /v1/complete-link-creation-requests |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | Yes | |
| Domain | form | string | No | |
| ParameterKeyValues | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| LinkResult | form | string | No | |
| Destinations | form | IEnumerable<ProductMetadata> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Author | form | string | No | |
| Url | form | Uri | No | |
| Description | form | string | No | |
| Retailer | form | string | No | |
| ProductImages | form | IDictionary<string, Uri> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/links HTTP/1.1
Host: api.booklinker.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"code":"String","url":"String","domain":"String","parameterKeyValues":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"success":false,"linkResult":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}