Skip to content

Latest commit

 

History

History
149 lines (110 loc) · 3.79 KB

client.md

File metadata and controls

149 lines (110 loc) · 3.79 KB
Raw

Client

The client object is the primary interface for making API calls through the SDK. It automatically manages API access token upkeep when possible, and has a number of options for altering the way calls are made. The various ways of creating an authenticated client are described in the Authentication documentation.

Custom API Calls

The client allows users to make API calls to any arbitrary API endpoint or URL, in order to provide flexibility for developers who may want to make calls not directly supported by the convenience methods provided by the managers (e.g. client.folders.get()).

These API calls will be sent with the client's access token and any other client settings, but requires passing in the URL, full request parameters, and handling the full response manually.

The URL argument for custom calls can be either an API endpoint path (e.g. '/files/1234') or a full URL (e.g. 'https://api.box.com/2.0/files/1234').

The params object contains request parameters and is often useful for passing query string, request body, or header parameters.

The response object that results from the call is an instance of http.IncomingMessage. By default the entire response will have already been read and the body will be attached as response.body.

GET

To make a GET call, call the client.get(url, params, callback) method with the URL of the endpoint and the request params.

var params = {
    qs: {
        fields: 'name,id'
    }
};

client.get('/files/1234', params, function(err, response) {

    if (err) {
        // handle error
    }

    console.log(response.body);
});

POST

To make a POST call, call the client.post(url, params, callback) method with the URL of the endpoint and the request params.

var params = {
    body: {
        name: 'My New Folder'
        parent: {
            id: '0'
        }
    }
};

client.post('/folders', params, function(err, response) {

    if (err) {
        // handle error
    }

    console.log(response.body);
});

PUT

To make a PUT call, call the client.put(url, params, callback) method with the URL of the endpoint and the request params.

var params = {
    body: {
        name: 'Changed Folder Name'
    }
};

client.put('/folders/1234', params, function(err, response) {

    if (err) {
        // handle error
    }

    console.log(response.body);
});

DELETE

To make a DELETE call, call the client.del(url, params, callback) method with the URL of the endpoint and the request params.

client.del('/folders/1234', null, function(err, response) {

    if (err) {
        // handle error
    }

    console.log(response.body);
});

OPTIONS

To make an OPTIONS call, call the client.options(url, params, callback) method with the URL of the endpoint and the request params.

client.options('/files/content', null, function(err, response) {

    if (err) {
        // handle error
    }

    console.log(response.body);
});