node-linked-in
v0.0.7
Published
NodeJS wrapper for the LinkedIn API
Downloads
28
Readme
node-linked-in
A Node.JS module, which provides an object oriented wrapper for the LinkedIn API.
Why ?
Because provided one is not friendly.
API
http://darul75.github.io/node-linked-in/#Linkedin
Install
npm install node-linked-in
Usage
var Linkedin = require('node-linked-in');
var cfg = {};
/* proxy example
var config = {
proxy: {
host: 127.0.0.1,
port: 8083
}
}*/
var linkedin = new Linkedin(cfg);
// or no specific
// var linkedin = new Linkedin();
// Oauth2 auth token, you might use https://github.com/ciaranj/node-oauth
// store info
linkedin.authenticate({
token: accessToken
});
// now you can play with API
linkedin.people.getCurrent({
"url-field-selector": ':(id,first-name,last-name,industry)'},
function(err, res) {
// current example retrieve current user profile info with specified fields
});
// "url-field-selector" is specific to LinkedIn API, see here for more details of syntax:
// https://developer.linkedin.com/documents/understanding-field-selectors
// PUT or POST methods use 'data' hash object
// see here for details as first json level attribute is omitted
// https://developer.linkedin.com/documents/api-requests-json
linkedin.groups.addPost({
"group-id": "12435",
"data": {
"title": "test",
"summary": "summary",
"content": {
"submitted-url": "http",
"submitted-image-url": "http",
"title": "ti",
"description": "des"
}
},
function(err, res) {
});
Options
- proxy: hash object
- debug: debug trace mode
proxy = {
"port": 8083,
"host": "127.0.0.1"
}
Whether process.env.HTTPS_PROXY or process.env.HTTP_PROXY are set, providing hash proxy is not needed.
Namespaces
var linkedin = new Linkedin(cfg);
// following namespaces expose methods for each linked api features
linkedin.people
linkedin.groups
linkedin.companies
linkedin.jobs
linkedin.shares
linkedin.communications
Implemented APIs
Metrics
License
The MIT License (MIT)
Copyright (c) 2014 Julien Valéry
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.