contentstack-management-java/src/main/overview.html at staging · contentstack/contentstack-management-java

History

101 lines (94 loc) · 18 KB

Raw

100

101

<!DOCTYPE html>

<html>

<head>

<title>Welcome file</title>

</head>

<h1 id="contentstack-management-java-sdk">Contentstack Management Java SDK</h1>

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. All you have to do is build your application frontend, and Contentstack will take care of the rest. <a href="https://www.contentstack.com/">Read More</a>.

This SDK uses the <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/">Content Management API</a> (CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the CMA, you will need to authenticate your users with a <a href="https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens">Management Token</a> or an <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken">Authtoken</a>. Read more about it in <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication">Authentication</a>.

Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always use the <a href="https://www.contentstack.com/docs/developers/apis/content-delivery-api/">Content Delivery API</a> to deliver content to your web or mobile properties.

<h2 id="prerequisite">Prerequisite</h2>

You need Java JDK 8 version or above installed on your machine to use the Contentstack Java CMS SDK.

<h3 id="installation">Installation</h3>

Install it via maven:

<groupId>com.contentstack.sdk</groupId> <artifactId>cms</artifactId> <version>{version}</version>

</dependency>

</code></pre>

Install it via gradle:

<pre class=" language-java"><code class="prism language-java">implementation 'com.contentstack.sdk:cms:{version}'

</code></pre>

To import the SDK, use the following command:

<pre class=" language-java"><code class="prism language-java">package com.contentstack.cms;

</code></pre>

<h3 id="authentication">Authentication</h3>

To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).

<h3 id="authtoken">Authtoken</h3>

An <a href="https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens/#authentication-tokens-authtokens-">Authtoken</a> is a read-write token used to make authorized CMA requests, and it is a user-specific token.

<pre class=" language-java"><code class="prism language-java">Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();

</code></pre>

<h3 id="login">Login</h3>

To Login to Contentstack by using credentials, you can use the following lines of code:

<pre class=" language-java"><code class="prism language-java">Contentstack contentstack = new Contentstack.Builder().build();

contentstack.login("EMAIL", "PASSWORD");

</code></pre>

<h3 id="management-token">Management Token</h3>

<a href="https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens/">Management Tokens</a> are stack-level tokens, with no users attached to them.

Stack stack = contentstack.stack("API_KEY", "MANAGEMENT_TOKEN");

</code></pre>

<h3 id="contentstack-management-java-sdk-5-minute-quickstart">Contentstack Management Java SDK: 5-minute Quickstart</h3>

<h4 id="initializing-your-sdk">Initializing Your SDK</h4>

To use the Java CMA SDK, you need to first initialize it. To do this, use the following code:

Contentstack contentstack = new Contentstack.Builder().setAuthtoken("AUTHTOKEN").build();

</code></pre>

<h4 id="fetch-stack-detail">Fetch Stack Detail</h4>

Use the following lines of code to fetch your stack detail using this SDK:

<pre class=" language-java"><code class="prism language-java">Stack stack = contentstack.stack("API_KEY");

Response<ResponseBody> response = stack.fetch().execute();

</code></pre>

<h4 id="create-entry">Create Entry</h4>

To create an entry in a specific content type of a stack, use the following lines of code:

// Create JSONObject to upload

JSONObject jsonBody = new JSONObject()

jsonBody.put("key", "value");

// Add Query parameters to the entry

entry.addParam("locale", "en-us");

Response<ResponseBody> response = entry.create(jsonBody).execute();

if (response.isSuccessful()){

System.out.println(response.body()); } else {

System.out.println(response.errorBody()); }

</code></pre>

<h4 id="create-asset">Create Asset</h4>

The following lines of code can be used to upload assets to your stack:

Asset asset = stack.asset();

// Add Query parameters to the entry

asset.addParam("title'","headeline")

Response<ResponseBody> response = asset.uploadAsset("filePath", "description").execute();

System.out.println(response.errorBody()); }

</code></pre>

<h3 id="helpful-links">Helpful Links</h3>

<ul>

<li><a href="https://www.contentstack.com/">Contentstack Website</a></li>

<li><a href="https://contentstack.com/docs">Official Documentation</a></li>

<li><a href="https://www.contentstack.com/docs/developers/apis/content-management-api">Content Management API Docs</a></li>

</ul>

<h3 id="the-mit-license-mit">The MIT License (MIT)</h3>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

overview.html

Latest commit

History

overview.html

File metadata and controls