Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
kentico-cloud-content-management
Advanced tools
Readme
Javascript SDK for the Kentico Cloud Content Management API. Helps you manage content in your Kentico Cloud projects. Supports both
node.js
andbrowsers
.
To get started, you'll first need to have access to your Kentico Cloud project where you need to enable Content management API and generate access token
that will be used to authenticate all requests made by this library.
This library has a peer dependency on rxjs
which means you need to install it as well. You install it using npm
or use it directly in browser using one of the cdn
bundles.
npm i rxjs --save
npm i kentico-cloud-content-management --save
If you'd like to use this library directly in browser, place following script tags to your html page. You may of course download it and refer to local versions of scripts.
<script src="https://cdn.jsdelivr.net/npm/rxjs/bundles/rxjs.umd.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/kentico-cloud-content-management/_bundles/kentico-cloud-cm-sdk.umd.min.js"></script>
The following code example shows how to create new content item in your Kentico Cloud project.
import { ContentManagementClient } from 'kentico-cloud-content-management';
const client = new ContentManagementClient({
projectId: 'xxx', // id of your Kentico Cloud project
apiKey: 'yyy', // Content management API token
});
client.addContentItem()
.withData(
{
name: 'New article',
type: {
codename: 'article' // codename of content type
}
}
)
.toObservable()
.subscribe((response) => {
// work with response
},
(error) => {
// handle error
});
If you are using UMD
bundles directly in browsers, you can find this library under KenticoCloudContentManagement
global variable.
<!DOCTYPE html>
<html>
<head>
<title>Kentico Cloud CM | jsdelivr cdn</title>
<script src="https://cdn.jsdelivr.net/npm/rxjs/bundles/rxjs.umd.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/kentico-cloud-content-management/_bundles/kentico-cloud-cm-sdk.umd.min.js"></script>
</head>
<body>
<script type="text/javascript">
var CM = window['KenticoCloudContentManagement'];
var client = new CM.ContentManagementClient({
projectId: 'xxx',
apiKey: 'yyy'
});
client.addContentItem()
.withData(
{
name: 'New article',
type: {
codename: 'article'
},
}
)
.toObservable()
.subscribe((response) => {
// work with response
},
(error) => {
// handle error
});
</script>
</body>
</html>
The ContentManagementClient
contains several configuration options:
const client = new ContentManagementClient({
// configuration options
});
Option | Default | Description |
---|---|---|
projectId | N/A | Required - Id of your Kentico Cloud project |
apiKey | N/A | Required - Content management API Token |
baseUrl | https://manage.kenticocloud.com/v2/projects | Base URL of REST api. Can be useful if you are using custom proxy or for testing purposes |
retryAttempts | 3 | Number of retry attempts when error occures. To disable set the value to 0. |
httpService | HttpService | Used to inject implementation of IHttpService used to make HTTP request across network. Can also be useful for testing purposes by returning specified responses. |
retryStatusCodes | [500] | Array of request status codes that should be retried. |
Online API Reference documents latest version of this library and can be used to quickly find all exposed methods and objects. Documentation is generated from TypeScript
code and thus it should always be accurate.
If you want to mock http responses, it is possible to use external implementation of configurable Http Service as a part of the client configuration.
If you have any issues or want to share your feedback, please feel free to create an issue in this GitHub repository.
Contributions are welcomed. If you have an idea of what you would like to implement, let us know and lets discuss details of your PR.
FAQs
Official Kentico Cloud Content management SDK
The npm package kentico-cloud-content-management receives a total of 15 weekly downloads. As such, kentico-cloud-content-management popularity was classified as not popular.
We found that kentico-cloud-content-management demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.