Call the API Gateway from Oracle Visual Builder

Previous Next JavaScript must be enabled to correctly display this content

Call the API Gateway from Oracle Visual Builder

The last step in our implementation is to call the API from a HTML5 client: in this example case you are using the Oracle Visual Builder service.

Oracle Cloud Infrastructure API Gateway in the architecture acts as an HTTP front end to incoming requests. The gateway provides a number of useful features for managing APIs.

For this use case, you will use the following features:

Mapping of URLs, and REST VERBS, to Oracle Functions using the function's OCID.
Enforcing security by only allowing authenticated users the ability to execute functions.
Implementing CORS headers.

Within Oracle Visual Builder the service endpoint is configured just like any other OAuth endpoint. Based on the Oracle Identity Cloud Service configuration you set earlier, we will be using the OAuth mechanism called User Assertion oAuth 2.0. Because Oracle Visual Builder is a trusted client of Oracle Identity Cloud Service, it will proxy the logged-in user of Oracle Visual Builder to Oracle Identity Cloud Service, with the clientid and client secret as parameters. Oracle Identity Cloud Service will then return an access token Oracle Visual Builder can use to call the endpoint (our function, via the gateway). This token can then also be used to call an Oracle Fusion Applications Cloud Service REST URL as the authenticated user from Oracle Visual Builder.

If you have enabled CORS in the API Gateway definition and you are using HTTPS, then you can set the token relay flag to true. If this flag is true then Oracle Visual Builder will route all REST traffic directly to the REST service instead of going via the Oracle Visual Builder server: a great optimization technique providing you meet the requirements.

In this configuration, use the scope, client ID, and secret from the Oracle Identity Cloud Service application you created earlier.

Description of vbcs.png follows

Description of the illustration vbcs.png

Once this is done you can then build an Oracle Visual Builder application as normal and make use of the cloud native functions for the REST calls.

Title and Copyright Information

Extend SaaS applications with a cloud native approach

F28083-03

July 2020

Copyright © 2020, Oracle and/or its affiliates.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or “commercial computer software documentation” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.