Skip to end of metadata
Go to start of metadata

Introduction

Jitterbit API Proxy allows you to centrally secure, publish, and manage existing external APIs, in addition to your Jitterbit Harmony APIs, within the Jitterbit Harmony API Manager. Existing external APIs can be any HTTP endpoint such as: 

  • Developed in-house and manually coded

  • Acquired through on-premises or SaaS applications

  • Provided by partners or affiliates

API Proxy passes through traffic to an existing API providing security and governance in a standard manner. 

  • Supports pass through of authentication and leverages the Jitterbit API Manager Security Profiles for rate limiting, trusted IP ranges, and OAuth 2.0 authentication.

  • Leverages API logs and analytics for troubleshooting and monitoring performance and consumption trends.

  • Allows the documenting (using OpenAPI) and publishing of external APIs within your Developer’s Portal along with your Harmony iPaaS-based APIs to make all your APIs easy to discover and consume.

  • Enhances the functionality of existing APIs without coding by filtering out services you don’t want exposed to your proxy consumers.

  • You can divide services across multiple proxies to meet specific use cases and expose them to different API consumers.

  • Monitor and control the consumption of your APIs and reduce consumption costs of third-party APIs by imposing a limit on the number of calls based on business rules or API consumers’ needs.

  • You can proxy existing APIs using Private and Cloud Gateways.

NOTE: API Proxy is available within Jitterbit Harmony API Manager in version 9.6 and above.

API Proxy Entitlement and Subscriptions

If your Harmony subscription includes API Manager, API Proxy functionality is available in version 9.6 and above. Access to API Manager is determined by your Harmony subscription. If the API Manager application is not visible to you in the Harmony Portal, contact your Customer Success Manager (CSM) at success@jitterbit.com for additional information.

Subscriptions work the same as a Custom API or an OData Service:

  • An API Proxy consumes a single API URL against your organization's API subscription.

Even though each API Proxy allows multiple services to be assigned to a unique URL, the base API Proxy URL is consuming the entitlement and hits across all services on the single-API Proxy URL count against the hits per minute entitlement.

TIP: Before creating an API Proxy, you should have already registered for Jitterbit Harmony and set up an environment, Agent Group, role, and member as described in the Jitterbit Quick Start Tutorial. A quick review of the Prerequisites section in the API Manager Quick Start Guide is also recommended prior to creating your API Proxy.

Getting Started with API Proxy

View this video to preview the steps for creating an API Proxy:

Creating an API Proxy

API Manager is accessed from the Harmony Portal. The credentials you use depend on if your organization and account is configured to use Single Sign-On (SSO). Once you are logged in to the Harmony Portal, you can access the My APIs landing page using:

  • From the Harmony Portal landing page, select the API Manager card.

  • From any page within the Harmony Portal, use the hamburger menu in the top left corner to select API Manager.

  • From any page within API Manager, click the logo or words API Manager in the top left next to the menu.

The My APIs landing page displays the existing APIs for the selected organization. Statistics display the number of URLs that are currently published and in-use against the total number of API URLs and against the total number of Proxy URLs provided under the organization's subscription. 

Select New Proxy in the upper right side of the page to create a new API Proxy. Selecting New Proxy opens the Create New Proxy page. The process of creating and publishing a new API Proxy consists of four steps, each step is a separate page, and the step number is highlighted at the top of the page. 

You can navigate back to a previous step by selecting the step numbers on top of the page, or you can select Cancel at the bottom of each page to stop the process at any time.

Step 1 - Basic Settings

  • Proxy Name: Enter a name for the proxy in the Proxy Name field. The name should be short and describe the functionality of the proxy. The proxy name is important for internal identification and is also used in the service root (the public name) of the proxy.  The name automatically becomes part of the proxy URL.

  • Version#: Define a version method for this API Proxy and enter the version in the Version# field. While this is not required, it is highly recommended. The V1, V2, etc. naming convention is often utilized. You can use any alphanumeric character for the version, including a date. Special characters are not allowed in the version, except the period and the dash.  A maximum of 48 characters is allowed in the version field.

  • Environment: Click in the Environment field to display the dropdown list.  Select the Environment from the list.

  • Service Root: The Service Root is automatically populated with the Proxy Name entered above, translated into camel case. If a different service root is preferred, enter that name in the Service Root field. 

    • Jitterbit uses camel case in the service root. For example, the Proxy Name entered as "New Dog" automatically populates the Service Root field as "newDog". Additional information regarding camel case is available at Lodash.com

    • A space between words or any underscore "_" entered between words in the Proxy Name field are ignored in the Service Root.

    • An underscore "_" character may be entered manually within the Service Root field and is then included in the final proxy URL.

    • A manually entered space is not allowed in the Service Root or the final proxy URL.

    • Special characters, other than underscore, are not allowed in the Service Root or the final proxy URL.

  • Description: Enter a short description of the API Proxy in the Description field to identify the purpose and intent of the proxy. This description will appear in the My APIs index and may be useful to help project collaborators identify the proxy.

  • Scroll down to the Enable Debug Mode Until fields.

  • Enable Debug Mode Until: If desired, click the checkbox to Enable Debug Mode Until. The default date is the date debug is enabled and the default time is exactly one hour from the time debug is enabled. 

    • A popup message describes the debug mode processing and the consequences of running in debug mode for a longer period of time. 

    • Select Continue to enable debug mode or Cancel to disable.  

    • Click within the date field to display a calendar to set a longer period to run in debug mode. Two weeks is the maximum time allowed to enable running in debug mode. Select the day in the calendar.

    • Click in the time field. Click the up/down arrows to set the hour and minutes.

    • Select Set to confirm the selection.

    • Debug logging can be turned on at any time by hovering over the proxy card in the My APIs Index page and selecting View/Edit on the back side of the card.

  • Scroll down to the Timeout field.

  • Timeout: Enter the number of seconds in the Timeout field. The default is 30 seconds. The maximum is 180 seconds.

  • SSL Only: SSL communication security is enabled by default and is strongly recommended. To disable SSL Only, click the checkbox to clear it. 

  • Enable CORS: Click the checkbox to Enable CORS.

    • A warning message displays. Review the warning (go to https://www.w3.org/TR/cors/ for additional information). 

    • Select Continue to enable CORS or Cancel to disable.

  • Enable Verbose Logging: Click the checkbox to enable verbose logging.  Verbose logging for the proxy allows the user to decide whether each proxy log should contain request and response data.  This functionality helps monitor incoming and outgoing data as well as facilitate debugging proxy issues. 

    • When this option is selected, a popup window displays.  Select Continue to enable verbose logging or select Cancel to disable verbose logging and close the window.

    • This option can be enabled or disabled at any time by hovering over the proxy card in the My APIs Index page and selecting View/Edit on the back side of the card.

  • Next: Select Next to save the information entered in step 1 and continue to step 2.

  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in step 1.

  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.

  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

Step 2 - Existing API

  • Service URL:  The Service URL displays at the top of the page in steps 2 through 4. As shown above, the service URL is https://Jitterbit########.jitterbit.org/ProdS/v1.0/newDog. The service URL is created as the fields are populated within the basic settings in step 1:

    • https://Jitterbit########.jitterbit.org: This is the base API URL for your org. The base URL is composed of your organization's org number, assigned at the time the subscription license is purchased (Format: JitterbitTrial#####), and your Harmony region (APAC, EMEA, NA).

      • APAC Region Base URL:    JitterbitTrial#####.Jitterbit.cc

      • EMEA Region Base URL:   JitterbitTrial#####.Jitterbit.eu

      • NA Region Base URL:       JitterbitTrial#####.Jitterbit.net

    • /ProdS: This is determined by the selection in the Environment field in step 1 and is the value in the URL Prefix field of the environment. The URL Prefix field is populated at the time the environment is created. The URL prefix is limited to a maximum of 48 characters. Detailed instructions for setting up environments are available within our existing Management Console documentation on the Environments page.

    • /v1.0: The value entered in the Version# field of step 1.

    • /newDog: This is the value in the Service Root field in step 1. In this example, we allowed the value entered in the Proxy Name field to autofill the Service Root field using camel case. See Service Root for additional information.

  • Base API URL: Enter or copy and paste the API URL into the Base API URL field. This is the complete URL of the existing API without the service path. This is the source API that is being proxied. 

    • Hover over the information iconto view a detailed example to assist you in entering the base API URL. 

    • A validation error displays below the Base API URL field when an invalid URL is entered.

      Proxy for a Single Service API:

      • If you are creating a proxy for an API that provides a single service, you can enter the complete API URL (Base API URL + Service Path) in the Base API URL field in step 2. As an example, enter "https:/example.com/servicepath" in the Base API URL field in step 2. Click Next.

      • In step 3, enter "NewService" in the Service Name field and enter a forward slash (“/”) in the Path field to point to root. Click Add Service.

      Proxy for a Multiple Service API:

      • If you are creating a proxy for an API that provides multiple services, enter only the Base API URL in the Base API URL field in step 2. As an example, enter "https://api.example.com" in the Base API URL field in step 2. Click Next.

      • In In step 3, as an example, enter "Service One " in the Service Name field and enter "/path1" in the Path field for the first service. Click Add Service.

      • Enter "Service Two" in the Service Name field and enter "/path2" in the Path field for the second service. Click Add Service.

      • Continue adding additional services until all desired services have been defined.

  • Provide OpenAPI Document: 

    • If you have OpenAPI documentation (YAML or JSON file), scroll down to the Provide OpenAPI Document section on the page. The steps to load OpenAPI documentation are outlined below

    • If you do not have OpenAPI documentation, you will define your services and methods manually in step 3. Scroll down to the bottom of this page to continue.

  • Next: Select Next to save the information entered in step 2 and continue to step 3.

  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in step 1 and step 2.

  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.
  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

Services and Methods Defined by OpenAPI Document


  • Provide OpenAPI Document: If you have OpenAPI (YAML) documentation, click the Yes radio button to open the Document Editor.
  • Three options are available to load OpenAPI documentation:

    • Load URL:  Click Load URL if your OpenAPI (YAML) documentation is available online. A popup window displays.

      • Paste the URL into the Document URL field.

      • Click Load to load the document into the editor. The YAML documentation displays in the Document Editor.

      • Click Cancel to close the popup without loading the URL.
    • Upload File: Click Upload File if you have either a YAML or JSON file.  A popup window displays.

      • Use the Browse button to browse to, select, and open the file.

      • Click Upload to load the file into the editor.  The YAML documentation displays in the Document Editor.

      • Click Cancel to close the popup without loading the file.
    • Document Editor: You can copy YAML documentation from another editor and paste directly into the Document Editor window.

  • Clear: Click the Clear link to delete the YAML documentation from the Document Editor.

  • Validation: A validation message displays directly below the Document Editor window.

    • If the YAML is valid, the message "YAML/JSON document is valid" displays below the editor

    • A validation error displays if the YAML is not valid, such as "end of the stream or a document separator is expected at Line #, column #". 

  • Next: Select Next to save the information entered in step 2 and continue to step 3.

  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in step 1 and step 2.

  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.
  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

    TIPS:

      • If YAML or JSON is not available, you can manually build the services and methods in step 3 by assigning a name and specifying the paths, specifying the method(s), and assigning them to the proxy. You can choose to define multiple services and not define others. This allows you to enhance and customize your proxy by defining new service names for existing functionality and filtering out or restricting the functionality accessible by the proxy without modifying the original existing API.

      • If YAML or JSON is available and uploaded, the API platform will auto-discover the APIs and services and display the available services in step 3 You can check the boxes to choose which services and methods you would like to include in your proxy and leave the boxes unchecked for the services you want to restrict access to.

Step 3 - Define Services & Methods

Examples shown below include first one where services and methods are defined based on OpenAPI documentation specified in step 2, and a second in which the services and methods are defined manually. You are required to define and add at least one service in order to continue to step 4.

Services and Methods Defined by OpenAPI Document

All the available services and methods defined in the YAML or JSON file are automatically identified and defined in the Harmony API platform. The services and methods are listed within the step 3 page:

  • Service Name:  This is the service name defined in the YAML or JSON file imported in step 2.

    • Click the associated checkbox to add a service to the API Proxy.

    • Services that are not checked are restricted and will not be available to the API Proxy.

    • Click the checkbox in the heading of the table to select all services and add all available services to the API Proxy.
  • Method:  This is the method defined and assigned to the service in the YAML or JSON file imported in step 2.

  • Path:  This is the service path defined and assigned to the API service in the YAML or JSON file imported in step 2.

  • Next: Select Next to save the information entered in step 3 and continue to step 4.

  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in steps 1, 2, and 3.

  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.
  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

Services and Methods Defined Manually

Each service must be defined manually if a YAML or JSON document was not provided in step 2Multiple services can be added to one proxy by separately defining a service name, associated path, and associated method(s). 

  • Service Name: Provide a Service Name.

  • Path: Provide the service Path. Hover over the information iconto the right of Path to assist you in building your proxy.

    NOTE: A path defined as "/" will match to any path available within the existing API that does not match to another path specifically defined in the proxy.

  • Methods: Select the checkbox for each Method that applies to the service.  For additional information about Get, Post, Put and Delete methods, see https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods.

  • Custom: A custom method includes any method not specifically listed under Methods. Selecting the Custom checkbox opens a new text field.

    • Each Custom method must be manually entered in the text field. 

    • Standard methods PATCH, OPTION, and HEAD are considered custom methods and require manual entry into the Custom text field to be assigned to your proxy.  

    • Assign multiple custom methods to one service by entering the methods separated by commas.

  • Add Service: Click Add Service.

  • As each service is defined and added to the proxy, the service displays in the table at the bottom of the page as shown in the image below.

KNOWN ISSUE: The PATCH method is currently not available in API Manager.

  • Once completed, all defined services and associated methods display in the table.

  • To delete a service, hover over the row and select the delete icon.

  • To make changes to an existing service, click on the row in the table.

    • The row is now highlighted, and the Service Name, Path, and Method fields are now populated with the existing service information.  
    • Make the necessary changes in the Service Name, Path, or Method fields.
    • Save Changes:  Select Save Changes to save the changes to the selected service and remain on the page.
    • Cancel: Select Cancel (above the table) to cancel the changes entered for the selected service and remain on the page.
  • Next: Select Next to save the information entered in step 3 and continue to step 4.

  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in steps 1, 2, and 3.

  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.
  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

Step 4 - Assign Security Profiles

Assigning a Harmony Security Profile to the proxy provides additional features such as rate limiting and IP whitelisting to further secure and protect your APIs against malicious attacks or abuse. Jitterbit recommends assigning a Harmony Security Profile, even if the existing API authentication mechanism is sufficient.

NOTE: There are three types of authentication available in API Manager:  Anonymous, Basic, and OAuth 2.0.  OAuth 2.0 is currently limited to Google, Salesforce, or Okta as the identity provider (IdP). See Harmony API Security and Security Profiles for additional information.

  • Available Profiles: Click within the Available Profiles field. Select an existing Security Profile from the dropdown list.

  • Assign Profile: Select Assign Profile to assign the selected profile to the new API Proxy you are creating.

  • Create New Profile: If an existing profile is not appropriate, click the Create New Profile link to open the Security Profiles page and create a new profile (see Security Profile Creation and Configuration). When you save the new profile, you are returned to step 4 to assign the new profile to the new API Proxy you are creating.

    • Within Security Profiles, create a new profile and then select Save.

    • You are automatically returned to step 4 of Create New Proxy.

    • The new Security Profile is automatically selected in the Available Profiles field.

  • Assign Profile: Select Assign Profile to assign the new profile to the new API Proxy you are creating.

  • As each profile is assigned, the profile displays in the Assigned Profiles table as shown in the image below. 

  • Repeat this step to assign multiple security profiles to the API. See Harmony API Security for additional information about assigning multiple profiles to an API.

  • Once completed, all assigned profiles display in the Assigned Profiles table.  To delete a profile, hover over the row and select the delete icon .

  • Scroll down to Request Headers

  • Request Headers: You can keep the existing request headers and pass them through unchanged or add new request headers, with the ability to override incoming request headers. 
    • Key: Provide the Key

    • Value: Provide the Value.

    • Override Incoming: Click the Override Incoming checkbox to override the incoming request header.

    • Click Assign Header Field.

  •  You can provide additional key/value pairs to create and assign multiple request headers to the proxy.
  • As each request header is assigned, the request header displays in the Header Fields table as shown in the image below.

  • Once completed, all assigned request headers display in the Header Fields table.  To delete a request header, hover over the row and select the delete icon .

  • To make changes to an existing header, click on the row in the table.

    • The row is now highlighted, and the Key, Value, and Override Incoming fields are now populated with the existing header information.  
    • Make the necessary changes in the Key, Value, and Override Incoming fields.
    • Save Changes:  Select Save Changes (above the table) to save the changes to the selected header and remain on the page.
    • Cancel: Select Cancel (above the table) to cancel the changes entered for the selected header and remain on the page.
  • Next: Select Next to save the information entered in step 4 and continue to the Summary & Confirmation page.
  • Cancel: Selecting Cancel at the bottom of the page or selecting the close icon  in the top right corner of the page, will close the page without saving the information already entered in steps 1, 23, and 4.
  • Save Changes: This option is available only after opening an existing API Proxy to edit, and it is activated only after changes are made to the page. Click Save Changes to save the changes you made in this page. A popup window displays a message giving you the option to Save Changes or Discard Changes.  Click Save Changes to save the changes you made, close the popup, and return to the Summary & Confirmation page. Click the Discard Changes link to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page.
  • Discard Changes: This option is available only after opening an existing API Proxy and only after you have made changes to the page. Click the Discard Changes link if you do not want to save the changes you made to this page. A popup windows displays a message giving you the option to Save Changes or Discard Changes. Click Discard Changes to delete the changes you made to this page, close the popup, and return to the Summary & Confirmation page. Click the Save Changes link to save the changes you made, close the popup, and return to the Summary & Confirmation page. 

NOTE:

  • You have the option of continuing to the next step without assigning a security profile to the proxy by selecting Next at the bottom of the page. If the proxy is published prior to assigning a security profile, it is anonymous and publicly accessible by default at the time it is published.
    • External API Authentication methods supported
      • This is the authentication against the existing API behind the proxy (proxy target).
      • Passthrough supports any existing authentication assigned to the existing API
      • Request Header should support passing through authentication tokens or credentials for Basic, OAuth (depending on type), and Custom
      • OAuth is supported within Request Headers only and may require manual refresh of authorization tokens

Summary & Confirmation

The Summary & Confirmation page displays all the settings and selections made in steps 1 through 4, allowing you to review, confirm, and edit the information prior to publishing the API Proxy. Each section of this page corresponds to a previous step.

  • Basic Settings: Along the top of the Summary & Confirmation page is a summary of the Basic Settings information entered in step 1, including the API Proxy name, environment, and description.
    • The Time Out, SSL Only, CORS, and Verbose Logging options are enabled if they display a check mark  to the left.  Each option that displays an  to the left is disabled.
    • Enable Debug Mode Until: An orange checkmark displays to the left of the date and time fields if debug mode is enabled.  The checkbox, date, and time are blank if debug mode is disabled. 
      • You can enable debug mode within this page by clicking the checkbox. The date and time will default to exactly one hour after you enable debug mode. 
      • A popup message describes debug mode processing and the consequences of running in debug mode for a longer period of time.  
      • Select Continue to enable debug mode or Cancel to disable debug mode and close the window.  
      • Click in the date field to select a different date in the calendar.  Click in the time field to select a different time.
    • Selecting the edit icon  to the right of the section returns the user to the step 1 page for editing. 
  • Existing API: The Existing API section displays the information entered in step 2. This is the complete existing API URL without the service path. This is the source API that is being proxied. 
    • Selecting the edit icon  to the right of the section returns you to the step 2 page for editing. 
  • Services & Methods:  The Service & Methods section displays the services entered in step 3, including the name, method, and path.   These are the services assigned to the proxy and available to consumers to access and execute. 
    • Selecting the edit icon  to the right of the section returns you to the step 3 page for editing. 
  • Security Profiles: This section displays the information entered in step 4 including the profile name and authentication type for each security profile assigned to the proxy. 
    • Selecting the edit icon  to the right of the section returns you to the step 4 page for editing.
  • Request Headers: This section displays the request headers assigned to the proxy in step 4.
    • Selecting the edit icon  to the right of the section returns you to the step 4 page for editing.
  • Export: This automatically exports the selected API Proxy to a file named apis-export.apk in your default download folder. This file can then be imported into a different environment or organization.
  • Clone: This option is available only after opening an existing API Proxy to edit. This creates an exact copy of the existing draft or published API Proxy, except for the Proxy Name, Service Root, and Version fields. The phrase "Copy of" is appended to the beginning of the text in the Proxy Name and Service Root fields. The text "-2" is appended to the end of the existing version.  The cloned API Proxy is immediately opened in a new Summary & Confirmation window. You can rename the proxy, edit selected information and then Save & Publish as a new API Proxy. You can change the version of the existing proxy and then Save as Draft until you are ready to publish the new version.
  • Delete: Click Delete to permanently delete the API Proxy from the organization and close the confirmation page. A popup message will ask you to confirm you want to delete the API Proxy.
    • If the API Proxy was published at the time of deletion, the proxy is removed from the My APIs page.  It is also removed from the number of Proxy URLs used against your subscription limit. 
    • If the API Proxy was previously saved as a draft, the proxy is removed from the My APIs page. The number of Proxy URLs used against your subscription limit does not change as the proxy was not accessible while in draft status.
    • Select Continue to completely delete the API Proxy.  Select Cancel if you want to close the popup window and return to the Summary & Confirmation page.

  • Save as Draft:  Click this button to save the information entered or changed in steps 1, 23, and 4 as a draft version.  The API Proxy will display on the My APIs page as Draft or Published w/ Draft. The Draft will not increase the number of Proxy URLs used against your subscription limit.
  • Save & Publish: Click this button to publish the API Proxy. The API Proxy is live and accessible within 5 minutes when accessed with the assigned profiles and authentication methods.
    • If the API Proxy was previously published, or was previously in Published w/Draft status, the API Proxy displays on the My APIs page as Published
      • The new published version of the API Proxy overwrites the previous published version.  There still is only one version that is accessible.  It does not increase the number of Proxy URLs used against the subscription limit. 
    • If the API Proxy is new, or was previously saved as a draft, the API Proxy displays on the My APIs page as Published.
      • The API Proxy is now accessible and increases the number of Proxy URLs used against the subscription limit.
    • A popup message displays indicating the Proxy is live.

      • Click on Copy URL and paste the URL into a browser window to quickly test the API proxy.
      • Click Dismiss to close the popup window.
  • Logs and debug logs (if enabled) for this API proxy will be available by selecting API Logs in the My APIs dropdown menu in the upper left corner of the My APIs page.
  • Performance metrics for the API proxy will be available by selecting Analytics in the My APIs dropdown menu.
  • To view the OpenAPI documentation for the new API Proxy, select Portal Manager from the My APIs dropdown menu in the upper left corner of the My APIs page.  Select Regenerate Docs & Publish.



On This Page

Last updated:  Aug 13, 2019


  • No labels