diff --git a/README.md b/README.md index ef58f7c..bbe89b5 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,77 @@ -
-

-Contentstack provides OpenAPI files for its Content Delivery and Content Management APIs in JSON format. These files allow you to automatically generate API documentation, test requests, and streamline your development workflow. -

-

-This tutorial walks you through how to use these JSON files with Swagger Editor to interact with Contentstack’s APIs. + src="https://images.contentstack.io/v3/assets/blt2d43f51baca745a8/bltddc0acd6b98c881c/Contentstack-Logo" width="70" height="75"> +

Contentstack CDA/CMA OpenAPI

+

Contentstack provides OpenAPI files for its Content Delivery and Content Management REST APIs. These files are in + JSON format. Using these JSON files, you can automatically generate API documentation, test API, and do a lot more.

+

This tutorial will walk you through the process of using Contentstack APIs (Content Delivery and Content Management + APIs) with Swagger.


Content Delivery API (CDA)

- - -

-To use CDA with Swagger, follow these steps: -

+

Version: 3.0.0 [Download]

+

Last Updated: Feb 06, 2023

+

Note: To use the latest version, download + the CDA file on your system.

+

To use Contentstack Content Delivery API (CDA) with Swagger, perform the following steps:

    - -
  1. Download the latest CDA JSON file and navigate to Swagger Editor.
    2. - -
  2. Click File on top-right and select Import File to upload the JSON.
    3. - -
  3. Open any API request and click the Try it out button to unlock the parameter fields.
    4. - -
  4. Enter your stack's values or use the default demo stack credentials.
    5. - -
  5. Click Execute.
    6. +
  6. Download + the CDA file and go to the Swagger Editor.
    7. +
  7. On the “Swagger Editor” page, click on File, and select the Import file option. +
-

-The Responses section will display the following: -

+

Alternatively, if you want to use the Import URL option, you can upload the CDA + file as an asset in Contentstack, and then paste the asset’s URL in the prompt.

+
    +
  1. Open any API request and click on the Try it out button. Clicking this button will unlock the + fields, so you can either run the API request on our demo stack or can use your own values.
    2. +
  2. Click on Execute.
    3. +

+

In the Responses section, you can see the following details:

-

-Note: To ensure you are testing against the most accurate environment, always download the latest CDA file from the Contentstack documentation site. -

-

Content Management API (CMA)

- - -

-To use CDA with Swagger, follow these steps: -

+
  • API request in CURL format
    • +
  • Response body
    • +
  • Status code
    • +
    +

    Content Management API

    +

    Version: 3.0.0 [Download]

    +

    Last Updated: Feb 06, 2023

    +

    Note: To use the latest version, download + the CMA file on your system.

    +

    To use Contentstack Content Management API (CMA) with Swagger, perform the following steps:

      - -
    1. Download the latest CMA JSON file and navigate to Swagger Editor.
      2. - -
    2. Click File on top-right and select Import File to upload the JSON.
      3. - -
    3. Before running a request, ensure you have an authentication method ready:
      4. - -
    4. Management Token: We recommend using a management token for CMA requests. Refer to the Generate Management Token guide for details.
      5. - -
    5. Authtoken: Run the Log in API request under the User Session section to retrieve an authtoken in the response.
      6. - -
    6. Open any API request and click the Try it out button to unlock the parameter fields.
      7. - -
    7. Enter your stack's values or use the default demo stack credentials.
      8. - -
    8. Click Execute.
      9. -
    -

    -The Responses section will display the following: -

    +
  • Download + the CMA file and go to the Swagger Editor.
    • +
  • On the “Swagger Editor” page, click on File, and select the Import file option. +
    • +
  • Alternatively, you can upload the CMA + file as an asset in Contentstack. Then, you can use the Import URL option and paste the + asset’s URL in the prompt.
    • +
  • To run any API request for CMA, make sure you have either the Management token or Auth token in hand.
      +
    1. To use a management token, refer to the Generate Management token guide.
      2. +
    2. To use Auth token, run the Login API request, located under the User Session + section.
      3. +
    +
    • +
  • Open any API request and click on the Try it out button. Clicking this button will unlock the + fields for you to use your enter the values.
    • +
  • Click Execute.
    • +
    +

    In the Responses section, you can see the following details:

    -

    -Note: -

    +

    Points to note:

    We recommend using the Management token for executing CMA requests rather than Auth token. +
  • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger. In such scenarios, + refer to the documentation link provided in the call for more details.
    • +