@zesty-io/sdk

1.0.0 • Public • Published

node-sdk version badge

Zesty.io software development kit (SDK) for the node.js runtime

what is zesty.io?

Zesty.io is a web content management system (WCMS) that is API driven with open-source user interfaces. Our software is built to automate the configuration, optimization, and distribution of digital content so marketing teams and developers can focus on creating excellent digital experiences. Learn more in our platform knowledge base.

Usage

prerequisites

installing

npm install @zesty-io/sdk

sdk client reference

Once you have the prerequisites meet and the sdk installed, review our guide to getting started using the node-sdk

Development

By providing a .env file a developer can override the default production settings and develop the SDK code against alternate (non-production) services.

When developing against alternate environments you will need to use credentials (token / user) from that alternate env. e.g. Testing against stage requries using a instance access token that exists on the stage isntance.

// These are the basic SDK values. 
ZESTY_INSTANCE_ZUID=
ZESTY_USER_EMAIL=
ZESTY_USER_PASSWORD=

// Services that are used can be overriden to use alternate service locations.
// e.g. local development services
ZESTY_AUTH_API=
ZESTY_ACCOUNTS_API=
ZESTY_INSTANCE_API=
ZESTY_MEDIA_API=
ZESTY_COOKIE=

// The included SDK tests require providing resource ZUIDs to run against
TEST_ITEM_VERSION=
TEST_BIN_ZUID=
TEST_GROUP_ZUID=
TEST_FILE_ZUID
TEST_MODEL_ZUID=
TEST_ITEM_ZUID=
TEST_FIELD_ZUID=
TEST_AUDIT_LOG_ZUID=
TEST_PUBLISH_ZUID=
TEST_HEAD_TAG_ZUID=
TEST_VIEW_ZUID=
TEST_PREVIEW=

testing

npm test

License

GNU

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.0
    44
    • latest

Version History

Package Sidebar

Install

npm i @zesty-io/sdk

Weekly Downloads

75

Version

1.0.0

License

GNU

Unpacked Size

112 kB

Total Files

40

Last publish

Collaborators

  • zestyionpm