aylien-news-api
AylienNewsApi - JavaScript client for aylien-news-api
The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 5.2.3
- Package version: 5.2.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit https://newsapi.aylien.com/
Installation
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install aylien-news-api --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your aylien-news-api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var AylienNewsApi = require('aylien-news-api');
var defaultClient = AylienNewsApi.ApiClient.instance;
var app_id = defaultClient.authentications['app_id'];
app_id.apiKey = "YOUR API KEY"
var app_key = defaultClient.authentications['app_key'];
app_key.apiKey = "YOUR API KEY"
var api = new AylienNewsApi.DefaultApi()
var body = null;
var opts = {
'publishedAtStart': "publishedAtStart_example",
'publishedAtEnd': "publishedAtEnd_example",
'_return': ["null"],
'sortBy': "'published_at'",
'sortDirection': "'desc'",
'cursor': "'*'",
'perPage': 10
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.advancedListStories(body, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://api.aylien.com/news
Documentation for Models
Documentation for Authorization
app_id
- Type: API key
- API key parameter name: X-AYLIEN-NewsAPI-Application-ID
- Location: HTTP header
app_key
- Type: API key
- API key parameter name: X-AYLIEN-NewsAPI-Application-Key
- Location: HTTP header