Customer Portal: Stage & Promote APIs

In Release 25B, we’re introducing new APIs to support the staging and promotion of file changes within the customer portal:

  • Stage API: Deploys modified files from development to staging. Admins can use the files/modified API to retrieve a list of modified files and then deploy them to the staging environment.
  • Promote API: Deploys files from staging to production, automating the final step of the deployment pipeline.

Both APIs use session authentication for secure access and are designed to integrate with CI/CD workflows, enabling automated file deployments and streamlining the customer portal development process.

       Customer Portal Session Authentication permission in Profile Permissions Designer

           Customer Portal Session Authentication permission in Profile Permissions Designer

Business Value:

  • Automation: Automates the deployment process, reducing manual effort in the customer portal development.
  • CI/CD Integration: Supports seamless integration with custom CI/CD workflows, enabling faster and more consistent deployments.
  • Secure Access: Provides secure, role-based access through session authentication.
  • Faster Time to Production: Accelerates the deployment process from development to staging to production.
     

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Upgrade CX site to 25B and CP to 3.11.

Tips And Considerations

Pre-Requisites:

  • CP version: 3.11
  • CX Versions: 25B

Access Requirements

The profile must have the .NET Profile Designer access to allow permission to use the Customer Portal APIs.
The account used to access the CP APIs must have Customer Portal API session authentication permission and also the CP stage and Promote access.