Booklinker.API

<back to all web services

PostLinkCreationRequest

Requires Authentication
The following routes are available for this service:
POST/v1/links
POST/v1/complete-link-creation-requests
"use strict";
export class PostLinkCreationRequestBase {
    /** @param {{url?:string,domain?:string,parameterKeyValues?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    url;
    /** @type {string} */
    domain;
    /** @type {{ [index:string]: string; }} */
    parameterKeyValues;
}
export class ProductMetadata extends ProductMetadata {
    /** @param {{title?:string,author?:string,url?:string,description?:string,retailer?:string,productImages?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PostLinkCreationResponse {
    /** @param {{success?:boolean,linkResult?:string,destinations?:ProductMetadata[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    success;
    /** @type {string} */
    linkResult;
    /** @type {ProductMetadata[]} */
    destinations;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PostLinkCreationRequest extends PostLinkCreationRequestBase {
    /** @param {{code?:string,url?:string,domain?:string,parameterKeyValues?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    code;
}
export class ProductMetadata {
    /** @param {{title?:string,author?:string,url?:string,description?:string,retailer?:string,productImages?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    title;
    /** @type {string} */
    author;
    /** @type {string} */
    url;
    /** @type {string} */
    description;
    /** @type {string} */
    retailer;
    /** @type {{ [index:string]: string; }} */
    productImages;
}

JavaScript PostLinkCreationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"code":"String","url":"String","domain":"String","parameterKeyValues":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}