cruk_content_api

CrukContentApi - JavaScript client for cruk_content_api The public read-only REST API for the Cancer Research UK Content Product API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cruk_content_api --save

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

Finally, switch to the directory you want to use your cruk_content_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cruk_content_api') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 CrukContentApi = require('cruk_content_api');

var defaultClient = CrukContentApi.ApiClient.instance;

// Configure API key authorization: APIKeyHeader
var APIKeyHeader = defaultClient.authentications['APIKeyHeader'];
APIKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyHeader.apiKeyPrefix['X-API-Key'] = "Token"

var api = new CrukContentApi.DefaultApi()

var cRUKSite = "\"foo\""; // {String} The machine name of the site to filter by.

var opts = { 
  'id': "\"foo:77307531-539f-4c96-a73c-122585936c76\"", // {String} A comma-seperated list of content IDs to load
  'cRUKDraft': false, // {Boolean} If present the API will return draft versions of content.
  'offset': 0, // {Number} The number of results to offset the result set from.
  'limit': 10 // {Number} The maximum number of results to return.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contentGet(cRUKSite, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CrukContentApi.DefaultApi | contentGet | GET /content | Get a list of content pages. CrukContentApi.DefaultApi | layoutsGet | GET /layouts | Get a list of layouts. CrukContentApi.DefaultApi | menusGet | GET /menus | Get a list of menu items. CrukContentApi.DefaultApi | prettypathsGet | GET /prettypaths | Get a list of prettypaths. CrukContentApi.DefaultApi | redirectsGet | GET /redirects | Get a list of redirects. CrukContentApi.DefaultApi | sitesGet | GET /sites | Get a list of sites. CrukContentApi.DefaultApi | termsGet | GET /terms | Get a list of terms.

Documentation for Models

• CrukContentApi.Content
• CrukContentApi.Error
• CrukContentApi.InlineResponse200
• CrukContentApi.InlineResponse2001
• CrukContentApi.InlineResponse2002
• CrukContentApi.InlineResponse2003
• CrukContentApi.InlineResponse2004
• CrukContentApi.InlineResponse2005
• CrukContentApi.InlineResponse2006
• CrukContentApi.Layout
• CrukContentApi.MenuItem
• CrukContentApi.Prettypath
• CrukContentApi.Redirect
• CrukContentApi.Site
• CrukContentApi.SiteProposition
• CrukContentApi.SiteSubProposition
• CrukContentApi.TaxonomyTerm

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header