OIC Vanity URL Setup Guide

Introduction

Oracle Integration Cloud Vanity URL is an important capability in modern enterprise integrations, especially when organizations want to expose clean, branded, and secure endpoints instead of default system-generated URLs. In real-world Oracle Integration Cloud (OIC Gen 3) implementations, clients rarely prefer exposing standard Oracle URLs to external consumers due to branding, security, and governance concerns.

From a consultant’s perspective, implementing a vanity URL in Oracle Integration Cloud is not just a cosmetic change—it plays a key role in API management strategy, security compliance, and enterprise architecture alignment.

In this blog, we will go deep into how vanity URLs work in Oracle Integration Cloud, how to configure them, and what practical considerations you must keep in mind during implementation.

What is Oracle Integration Cloud Vanity URL?

A Vanity URL in Oracle Integration Cloud is a custom domain URL that replaces the default OIC endpoint URL for integrations or APIs.

Default OIC URL Example:

Vanity URL Example:

This allows enterprises to:

• Maintain brand identity

• Hide internal infrastructure details

• Provide consistent API endpoints across environments

Real-World Integration Use Cases

1. External Partner API Exposure

A retail company integrates with logistics vendors. Instead of exposing OIC URLs, they use:

Why?

• Vendors trust branded domains

• Easier documentation

• Avoids revealing internal cloud structure

2. Multi-Environment Strategy (DEV/TEST/PROD)

Instead of using different OIC instance URLs:

• DEV: dev.api.company.com

• TEST: test.api.company.com

• PROD: api.company.com

This ensures:

• Clean environment separation

• Easier DevOps management

3. API Gateway Integration

Organizations using OCI API Gateway or external gateways (like Apigee) use vanity URLs to:

• Route traffic centrally

• Apply security policies (OAuth, throttling)

• Log and monitor APIs

Architecture / Technical Flow

In Oracle Integration Cloud (Gen 3), vanity URLs are typically implemented using OCI API Gateway + Custom Domain + DNS mapping.

Flow:

1. Client calls Vanity URL

2. DNS resolves to API Gateway

3. API Gateway routes request to OIC endpoint

4. OIC processes integration

5. Response sent back via Gateway

Key Components:

Prerequisites

Before implementing a vanity URL, ensure the following:

1. OCI Access

• Access to OCI Console

• API Gateway permissions

2. Domain Name

• Example: api.company.com

• Managed via OCI DNS or external DNS provider

3. SSL Certificate

• Required for HTTPS

• Can be:

  • Oracle-managed

  • Self-uploaded certificate

4. OIC Integration Endpoint

• REST-based integration deployed and active

5. IAM Policies

Ensure proper policies like:

Step-by-Step Build Process

Step 1 – Create Integration in OIC

Navigate:

• Choose REST Adapter

• Define endpoint (e.g., /customer/create)

• Activate integration

Example:

• Method: POST

• Endpoint: /customer/create

• Payload: JSON

Step 2 – Get OIC Endpoint URL

After activation:

Example:

Step 3 – Create API Gateway

Navigate:

Provide:

• Name: OIC-Gateway

• Compartment

• Subnet (public)

Step 4 – Create Deployment in API Gateway

Navigate:

Define:

Route Configuration:

• Path: /customer/create

• Method: POST

Backend Type:

• HTTP Backend

Backend URL:

Paste OIC endpoint

Step 5 – Configure Custom Domain (Vanity URL)

Navigate:

Provide:

• Domain Name: api.company.com

• Certificate: Upload or select SSL cert

Step 6 – Map Deployment to Custom Domain

• Associate deployment with custom domain

• Define base path mapping

Example:

Step 7 – Configure DNS

In OCI DNS or external provider:

Create record:

Step 8 – Test Vanity URL

Test using Postman:

Testing the Technical Component

Sample Request Payload

Expected Response

Validation Checks

• URL resolves correctly

• SSL certificate is valid

• Integration executes successfully

• No direct OIC URL exposure

Common Errors and Troubleshooting

1. DNS Not Resolving

Cause:

• Incorrect DNS mapping

Solution:

• Verify A/CNAME records

• Check propagation

2. SSL Certificate Issues

Error:

Solution:

• Ensure correct certificate chain

• Match domain name

3. 404 Not Found

Cause:

• Incorrect route mapping

Solution:

• Verify API Gateway path

• Match integration endpoint

4. Unauthorized Errors

Cause:

• Missing authentication config

Solution:

• Configure:

  • Basic Auth

  • OAuth

  • API Key

5. Timeout Issues

Cause:

• Long-running integration

Solution:

• Optimize integration logic

• Use async pattern if needed

Best Practices

1. Use API Gateway Always

Avoid directly exposing OIC endpoints. API Gateway provides:

• Security

• Rate limiting

• Monitoring

2. Maintain Environment-Based URLs

3. Implement Security Policies

• OAuth 2.0

• API Keys

• IP Whitelisting

4. Logging and Monitoring

Use:

• OCI Logging

• API Gateway metrics

• OIC tracking

5. Version Your APIs

Example:

6. Avoid Hardcoding URLs

Use:

• Environment variables

• Configuration tables

7. Use Naming Standards

Keep URLs consistent:

Real Consultant Tip

In one of our implementations for a banking client, exposing OIC URLs directly caused security audit failures. Once we implemented vanity URLs using API Gateway with OAuth policies:

• Audit passed successfully

• API response times improved due to caching

• Centralized monitoring simplified support

This is why vanity URLs are considered a must-have in enterprise OIC projects.

Summary

Oracle Integration Cloud Vanity URL is not just about making URLs look clean—it is a critical part of enterprise API strategy.

By implementing vanity URLs:

• You improve security

• You standardize API access

• You enhance brand trust

• You simplify integrations for external systems

In Oracle Integration Cloud (Gen 3), the combination of API Gateway + Custom Domain + DNS provides a robust and scalable way to implement this feature.

For any real-world OIC project, this should be part of your initial architecture design, not an afterthought.

FAQs

1. Can we create vanity URLs without API Gateway in OIC?

No, Oracle Integration Cloud does not natively support custom domains. API Gateway (or external gateway) is required to implement vanity URLs.

2. Is vanity URL setup different in OIC Gen 3?

The concept remains the same, but Gen 3 provides better integration with OCI services like API Gateway, making setup more seamless and scalable.

3. Can we use external API Gateways instead of OCI API Gateway?

Yes, tools like Apigee, Kong, or Azure API Management can also be used. However, OCI API Gateway provides native integration and simpler setup within Oracle ecosystem.

Learn More

For deeper understanding, refer to Oracle official documentation:

https://docs.oracle.com/en/cloud/saas/index.html