https://github.com/mtchavez/node-al-papi
Node Package for AuthorityLabs Partner API
https://github.com/mtchavez/node-al-papi
Last synced: about 2 months ago
JSON representation
Node Package for AuthorityLabs Partner API
- Host: GitHub
- URL: https://github.com/mtchavez/node-al-papi
- Owner: mtchavez
- Created: 2012-04-07T04:28:52.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2014-07-31T15:10:51.000Z (almost 11 years ago)
- Last Synced: 2024-04-26T04:03:56.147Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 200 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Node.js AuthorityLabs Partner API Package
=========================================
A wrapper around the Partner API calls. Allows post, priority post and get calls.
* Github: http://github.com/mtchavez/node-al-papi
* [](http://coderwall.com/mtchavez)
## Install
npm install al-papi
## Usage
Make a request object using your api key:
// Require al-papi
var al = require('al-papi');
// Configure using your api-key
al.AlConfig('yRR2tB39jStovMy6y6xP');
// Make request object to make api calls
var req = new al.AlRequest();
### POST
Post your keyword-engine-locale combination to the API:
req.post({'keyword' : 'Centaur Soirée'}, function(response) {
console.log(response.statusCode);
console.log(response.url);
console.log(response.params);
if (response.success) {
console.log(response.body);
}
else {
console.log(response.errorMessage);
}
});
### Priority POST
Post your keyword to the priority queue if you need results in a more timely manner:
req.priority_post({'keyword' : 'Centaur Soirée'}, function(response) {
console.log(response.statusCode);
console.log(response.url);
console.log(response.params);
if (response.success) {
console.log(response.body);
}
else {
console.log(response.errorMessage);
}
});
### GET
When you are ready to get your results you can do a GET request for your keyword-engine-locale combo:
req.get({'keyword' : 'Centaur Soirée'}, function(response) {
console.log(response.statusCode);
console.log(response.url);
console.log(response.params);
if (response.success) {
console.log(response.body);
}
else {
console.log(response.errorMessage);
}
});
### Response
When making an API request a response object is returned with any errors, http response code and http reponse body.
req.get({'keyword' : 'Centaur Soirée'}, function(response) {
console.log(response.statusCode); // Status code of response
console.log(response.url); // The URL used for your request
console.log(response.params); // Original params given
// success is a true/false of if the request received a 200 response code
if (response.success) {
// Body will be the parsed JSON response
console.log(response.body);
}
else {
// Error message if one exists
console.log(response.errorMessage);
}
});
## Web Insight
### Description
Web Insight queue takes a URL for the Partner API to scrape and parse out high level insight about the page
and return the results to your callback URL passed in or set for your account.
### POST
Post the URL of the page you want to gain insight into and the callback URL knowing when your results are
ready to get.
req = new al.AlWebInsight();
req.post({'url' : 'http://www.qwiki.com', 'callback' : 'http://api.authoritylabs.com/callbacks?from=node'}, function(response) {
console.log(response.statusCode);
console.log(response.url);
console.log(response.params);
if (response.success) {
console.log(response.body);
}
else {
console.log(response.errorMessage);
}
});
### GET
When your results are ready to get you will receive a callback that contains the information on how
to get the insight on your URL. In the callback you should receive a date_created and time_created to use
in your get request. You will also use your original URL posted.
req = new al.AlWebInsight();
req.get({'url' : 'http://www.qwiki.com', 'date_created' : '2012-06-14', 'time_created' : '01:50'}, function(response) {
console.log(response.statusCode);
console.log(response.url);
console.log(response.params);
if (response.success) {
console.log(response.body);
}
else {
console.log(response.errorMessage);
}
});
## License
Written by Chavez
Released under the MIT License: http://www.opensource.org/licenses/mit-license.php