ied-seismic v1.1.9

ied-seismic

Seismic is an asset management system which has an api system for retrieving & updating info on the app. This package helps resolve common tasks performed by teams, such as retrieving assets, extending expiration dates, and checking broken links.

Prerequisites

This package uses the Seismic API to perform various functions. You will need to request for API access and provide those details when using the "connect" functions. Instructions can be found at https://developer.seismic.com/seismicsoftware/docs/getting-started

Upon success you will receive the following details,

{
  "client_id": "...",
  "client_secret": "...",
  "user_id": "...",
  "grant_type": "...",
  "scope": "...",
  "tenant": "IBM"
}

Installing

npm install ied-seismic

Getting Started

// Import the package (make sure to install)
const seismic = require("ied-seismic")
// Create a js object containing your connection details ()
const config = {
  "client_id": "...",
  "client_secret": "...",
  "user_id": "...",
  "grant_type": "...",
  "scope": "...",
  "tenant": "IBM"
}
seismic.connect(config)

Seismic API features

After connecting to the package, you can use any of the API related features by simply passing the asset id to the function.

seismic.getAssetInformation(ASSET_ID)

Seismic Non-API features (Experimental)

We are working on a few non API features such as the Seismic broken link checker. This feature crawls a seismic page and validates the links. To use this feature, a user needs to pass a link, or array of links.

seismic.checkForBrokenLinks([SEISMIC_LINKS])

Authors

Made by the IBM Enablement Developers.

Note the github for the project is on an IBM corporate github which cannot be shared publicly.