AEMasCS REST API calls from POSTMAN or any external application

This post details the steps to invoke REST API hosted in AEM as a Cloud Service (AEMasCS) instance from POSTMAN or any external application. 


As we all know AEM is REST based Web application and contents of Repository can be accessed via GET call to respective path (Eg say,  ".json" extension or content path with ".html" extension) and updates to Repository is possible via respective HTTP method type + API endpoint as exposed (Eg. Assets HTTP API Create Folder POST request), provided we have Authentication and Authorization to the accessing endpoints. 
  • Authentication is achieved using the credentials that we use to access our instance.
    • Eg. In our local AEM author instance, we login using admin/admin or any username as created/available in the respective instance
  • Authorization refers to the permissions to the path we are accessing 
    • Eg: If we are to make GET request on /content/we-retail.html, we need to have read permission on this path.
Given this understanding, when we want to access an endpoint from our AEM instance using POSTMAN, we need to set the Authentication information via  tab -> "Authorization" with respective Type. (Which would help generate an Authorization Header for making an HTTP request)
  • For Classic AEM instance, we need to use "Basic" Type -> respective Username and Password input as we would give in our AEM instance.
  • For AEMasCS instance(the one as hosted in cloud and NOT Cloud Service SDK instance), we need to use Token Based Authentication -> "Bearer" Type -> Token value as input. 
AEM instance 6.5.0:

Screenshot below highlights use of Assets HTTP API "Create Folder" request hosted in local classic AEM instance 6.5.0


AEMasCS instance:

For AEMasCS instance, Token value is acquired from AEM Developer console. 
  • For Local Development, we can use Temporary Access Token. 
  • For actual integration in case of an external application say from frontend app like React, we need to make use of Service Credentials. 
  • Details for the same is explained here in Adobe Doc with Video Demo and sample Node JS application for both Local Development Access Token and for Service Credentials
  • In POSTMAN, we need to input the Token as acquired above(using Local Development Access Token) in below highlighted screenshot. 
Note :  
  • Token Based authentication is required only when we access AEMasCS instance as available in cloud from any external application. 
    • In this case, external application is POSTMAN. 
    • In the sample illustrated in above Adobe doc, external application refers to Node JS application.
  • Highlighted in red in below screenshot is the dummy AEMasCS URL. I don't have access to any AEMasCS instance, It is used in the screenshot to highlight the usage.


I had a chance to respond to a query (related to this subject) raised in our Experience League Community recently. 
Below is the respective thread for reference. (Has sample request details to be used in React Code)

Comments

  1. HenryNovember 25, 2021 at 1:45 AM

    NFT Game Development Company | ICO Development Company | Token Development Services

    ReplyDelete
  2. John SteveMarch 29, 2022 at 5:01 AM

    Agile software outsourcing by a top Artificial Intelligence Technologies companies can help minimize costs and improve time to market.

    ReplyDelete
  3. SanaaMay 25, 2022 at 5:37 AM

    BEP20 Token Development Company
    ERC20 Token Development Company
    Solana Token Development Company
    NFT Token Development Company
    Polygon Token Development Company
    PancakeSwap Clone Script
    Smart Contract Development Company

    ReplyDelete
  4. Mercy - Crypto Business ConsultantJuly 5, 2022 at 2:56 AM

    Thanks for sharing the useful post.Keep it Up.Opensea Clone Script |
    Opensea Clone Software |
    PancakeSwap Clone Script |

    ReplyDelete
  5. Sophia LinneaJuly 27, 2022 at 2:47 AM

    This is Very Informative Post.
    Token Development Company
    ERC20 Token Development Company
    TRON Token Development Company
    Smart Contract Development Company
    BEP20 Token Development Company
    Metaverse Token Development Company
    Polygon Token Development Company
    ERC721 Token Development Company

    ReplyDelete
  6. kesterMay 31, 2023 at 6:30 AM

    Kraken clone script

    crypto copy trading software

    ReplyDelete
  7. CoindevelopmentcompanyJanuary 24, 2024 at 2:37 AM

    Coin Development Company Coin Development Company is a trusted partner in cryptocurrency development, offering expert team, tailored solutions, innovative technology, security, and comprehensive support. We specialize in coin creation, token development, smart contracts, and blockchain consulting. Our team focuses on staying ahead of the curve, ensuring your coin stands out in the market, and providing ongoing maintenance and updates to keep your coin running smoothly.

    ReplyDelete

Post a Comment

Popular posts from this blog

Embedding Third party dependency/OSGi bundle in AEM application hosted in AEMasCS

Image
This post illustrate the ways of embedding third party dependency in AEM maven project. Steps are mentioned considering the project structure to be followed for AEMasCS while the same can be followed for classic versions too.  Before we begin, I would like to explain the scenario of including a dependency in our AEM maven project.  When we would like to make use of an API that is not already available in our project, we look for that in maven-central repository and specify the dependency in main pom.xml and desired module's pom.xml file. (Lets say, AWS S3 Java SDK V2 dependency) Upon updating the project in the IDE, we would see our class files (making use of those APIs) are compiled/build successfully without any errors.  Now, in the context of AEM/OSGi environment, when the same package and hence the bundle is deployed to AEM instance, dependencies that we added new might not be resolved/available in the OSGi as a bundle. Something like the below This indicates that the added dep
Read more

OSGI Factory Configuration implementation

OSGI Factory configuration is used to have many instances of an OSGI config (represented/identified via an identifier) for the single OSGI service/PID. Most often used OOB Factory configurations for example: Logger Factory/writer configuration (for log statements) Service user Mapper service Amendment (for using service resource resolver in projects) Few sample real time use case for the need of OSGI factory config: For multi tenant projects, if we have generic service used across tenants with properties/attributes specific to tenant. For single tenant, generic service targeting all locales with properties/attributes specific to locale. (where generic service -> holds logic in the lines of calling third party service for retrieving/updating information.) Implementation: ( In terms of OSGI R6 annotations ): Create Object Class Definition(OCD) defining desired properties for the OSGI service. - OSGIFactoryConfigOCD.java OSGI Service/Factory service to retrieve
Read more

Creation of Template Types for Editable templates

Image
In this post, we will create templates types which is the base for creating editable templates. Before getting to the subject directly, have added an introduction about templates in general. Template is the base for creating pages. Starting AEM 6.2, we have categorisation for templates - Static and Editable templates. Static templates :  This has been available for several versions of AEM/CQ Created using "Create Template" option with base page component as resourceType (which is responsible for rendering the page structure).  Template ( base page component as resourceType ) -> Page This cannot be edited as such. Since it just holds a reference to base page component, any changes to the page (other than authorable components), would need a change in base page component which is ultimately a work of developer. (calls for a code change) Allowed components are configured using Design mode (list being saved to etc/designs/projectfolder/templatename/jcr:content)
Read more