Overview

In SnapLogic Project Manager, the API Manager console provides a space where you can create APIs by referencing a specification. The new API asset acts as a container for the following SnapLogic assets.

• Pipeline: The Pipeline is a representation of the API specification and provides the scaffolding of its implementation in the SnapLogic platform.
• Tasks: The URI endpoints used to trigger Pipeline execution.
• Files: A specification file. Both JSON and YAML file formats are supported.
• Accounts: Accounts in Project Manager referenced by Pipelines used in the API.

You can create an API using one of four ways:

• By uploading an Open API Specification (OAS) file (Design First) with either a JSON or YAML file extension.
• By entering a URL that points to an Open API Specification file (Design First)
• By creating an API from an existing project
• By starting with an empty API

The first version is automatically created when you create the API. However, you can create additional versions of your API and manage them.

Prerequisites

• APIM prerequisites for your environment (Org)
• Your API specifications must be based on Open API Specification (OAS) 3.0 or 2.0.
• You must have Write permissions to create an API.

Behavior Change

The Developer Portal no longer displays empty tags added during API Version or Proxy creation in the API details view.

API Manager

To navigate to the API Manager, in Project Manager go to API Management > API Manager.

APIs and Proxies appear in this list. You can view details about the API or Proxy by clicking it. You can also set permissions on your API.

Known Issue

Lint issues occur when working with reference accounts, associated JAR files, and error pipelines in older Snaplex versions. Workaround - Update the Snaplex to the latest version to resolve the lint issue.

Create the API Using Design First

1. In the API Manager page, under the APIs & Proxies tab, click the add icon and choose New API.
   
   
2. In Create New API, choose the source of the OAS file.
   • Upload File. Click Choose File to specify the location of the specification file to upload.
     
     
   • Enter URL. Enter a valid URL pointing to the location of the specification file.
     
     
3. Click Continue.
4. In Create New API - Options, select your API Import Configurations.
   
   
   • Create Specification. If selected, the imported specification is included as a File Asset in the API.
   • Create Endpoints from Path. If selected, endpoints for the new API are created based on its path to one of the following:
     • Triggered Task: Choose to make the API endpoint a Triggered Task.
     • Ultra Task: Choose to make the API endpoint an Ultra Task.
5. Click Import and Continue.
6. In Create New API - Details, fill in the details for the new API.
   
   
   • General Info:
     • Name (Title). The name of the new API. The name must meet the following requirements:
       • Must be unique.
       • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
       • Cannot contain the reserved keyword shared.
       • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
       • Must be no more than 256 characters.
       • If the name includes double-byte characters, the maximum length is shorter.
     • Description. A description of the new API.
     • Version. The version number for the first version of the API. Default: 1.0. Learn more: Managing Versions of Your APIs
     • Tags. Enter any tags associated with your API. You can create the tags as required.
   • Endpoint Configuration > Path to Endpoint. (Read-only) The base path for the endpoint.
   • Server Configuration > Snaplex. The Snaplex to associate with the new API.
7. Click Create.

Troubleshooting Section for API Specification file

Any structural or syntax issues in the API, API Version, or Proxy specification file results in an error in the SnapLogic UI. You can change the specifications according to the error message in the Swagger editor or any other editor tool.

Spec Contains Error
Structural error
Expecting property name enclosed in double quotes: line 33 column 29 (char 782)
Line 33
Column 29

Spec Contains Errors
Structural error at $
'invalidField' does not match any of the regexes: '^x-'

Spec Contains Errors
Structural error
Invalid API specification: 'str' object has no attribute 'get

Example Workflow

1. Create an API in the API Manager with the upload option. Upload the OAS 2.0 or 3.0 YAML or JSON API Specification file:
   
   
2. If the file contains incorrect data or a broken code structure, an error occurs:
   
   
3. You can edit the specification file in the Swagger editor:
   
   
4. After all the errors in the Swagger editor are fixed, the API is successfully created with the edited API specification file.

Create the API from Existing Project Assets

1. In the API Manager page, under the APIs & Proxies tab, click the add icon and choose New API.
2. In Create New API, choose Create from Existing Project and select the Project.
   
   
3. Click Continue.
4. In Create New API - Select Assets, select the types of assets you want to import to the new API. An Asset selected at the root level also imports the leaf-level Assets.
   
   
5. Click Import and Continue.
6. In Create New API - Details, fill in the details for the new API.
   
   
   • General Info:
     • Name (Title). The name of the new API. The name must meet the following requirements:
       • Must be unique.
       • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
       • Cannot contain the reserved keyword shared.
       • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
       • Must be no more than 256 characters.
       • If the name includes double-byte characters, the maximum length is shorter.
     • Description. A description of the new API.
     • Version. The version number for the first version of the API. Default: 1.0. Learn more: Managing Versions of Your APIs
     • Tags. Enter any tags associated with your API. You can create the tags as required.
   • Endpoint Configuration > Path to Endpoint. (Read-only) The base path for the endpoint.
   • Server Configuration > Snaplex. The Snaplex to associate with the new API.
7. Click Create.

Create the API from a Git Repository

1. In the API Manager page, under the APIs & Proxies tab, click the add icon and choose New API.
2. In Create New API, choose Create from Git Checkout.
   
   
   1. Repository: Select the Git repository from the dropdown list.
   2. Branches/Tags: Choose an existing branch or create a new branch:
      • Select the Branch or Tag to associate with your API.
      • (Optional) Enter a name to create a new branch from main.
        
        
   3. Click Continue.
3. In Create New API - Details, specify the details for the new API.
   
   
   • General Info:
     • Name (Title). The name of the new API. The name must meet the following requirements:
       • Must be unique.
       • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
       • Cannot contain the reserved keyword shared.
       • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
       • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.
     • Description. A description of the new API.
     • Version. The version number for the first version of the API. Default: 1.0.
     • Tags. Enter any tags associated with your API.
   • Endpoint Configuration > Path to Endpoint. (Read-only) The base path for the endpoint.
   • Server Configuration > Snaplex. The Snaplex to associate with the new API.
4. Click Create.
5. Navigate to the Assets tab of the API version to view the Git repository associated with the API version assets.
   
   

   The following image shows a new branch:

   
   
   
6. Select an asset and click the git ops icon to view available Git operations.

Creating an Empty API

1. In the API Manager page, under the APIs & Proxies tab, click the add icon and choose New API.
2. Choose Create Empty API.
   
   
3. Click Continue.
4. In Create New API - Details, fill in the details for the new API.
   
   
   • General Info:
     • Name (Title). The name of the new API. The name must meet the following requirements:
       • Must be unique.
       • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
       • Cannot contain the reserved keyword shared.
       • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
       • Must be no more than 256 characters.
       • If the name includes double-byte characters, the maximum length is shorter.
     • Description. A description of the new API.
     • Version. The version number for the first version of the API. Default: 1.0.
     • Tags. Enter any tags associated with your API. You can create the tags as required.
   • Endpoint Configuration > Path to Endpoint. (Read-only) The base path for the endpoint.
   • Server Configuration > Snaplex. The Snaplex to associate with the new API.
5. Click Create.

Creating an APIM API in IIP

You can create an APIM API in IIP through the following workflows:

• Designer
  • Creating a Triggered Task
  • Creating an Ultra Task
• Project Manager
  • From a project or Project Space shared folder dropdown list
  • Creating/editing a Triggered Task
  • Creating/editing an Ultra Task

1. Choose one of the following ways to open the dialog for a Triggered or Ultra Task:
   • In the Designer tab, click the Task icon from the expanded toolbar.
     
     
   • In the Project Manager tab, navigate to the target project or global shared folder, and In the assets table, do one of the following:
     • To create an APIM API from a task:
       1. For an existing Task, click on the target Task.
       2. Click the add icon and in the dropdown, select Task > Triggered or Task > Ultra. Alternatively, click the Tasks tab, then click the add icon and in the dropdown, select Triggered or Ultra. The task dialog for the task type you selected appears.
       3. Fill out the Task form with the appropriate information, then click Save and create API.
          
          
     • To create an APIM API from a project or Project Space share folder, click the dropdown icon to display the dropdown list, select Create API:
       
       
2. In the Create new API assets, select the target assets to include in your API, and then click Import and continue.
   
   
3. In the Create new API details, enter the details.
   
   
   • General Info:
     • Name (Title). The name of the new API. The name must meet the following requirements:
       • Must be unique.
       • Must begin with alphanumeric characters A-Z, a-z, or 0-9.
       • Cannot contain the reserved keyword shared.
       • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.
       • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.
     • Description. A description of the new API.
     • Version. The version number for the first version of the API. Default: 1.0.
     • Tags. Enter any tags associated with your API.
   • Endpoint Configuration > Path to Endpoint. (Read-only) The base path for the endpoint.
   • Server Configuration > Snaplex. The Snaplex to associate with the new API.
4. Click Create.
5. Navigate to the API Manager to verify API creation.

Edit an API Name

Rename the API to align with the company standards and best practices. Save the extra effort instead of copying the API to rename it and then deleting the old one.

1. Navigate to API Manager > API > API details.
   
   
2. Click Edit Details to rename the API:
   
   
3. Click Save. A message “API details has been updated successfully” displays in the UI.

Enabling "Try It Out" for Your API

To allow API users to try out your API,

• A CORS Restriction policy must be defined.
  • If CORS Setting > Enable Try Me is selected in Developer Portal settings, the default CORS Restriction policy is applied to all APIs in the Developer Portal. Learn how to select the setting. You must be an Environment admin to modify the Developer Portal settings.
  • If not selected or if you want to override the default CORS Restriction policy, you can add your own CORS Restriction policy to your API or API version. Learn how to add and configure the CORS Restriction policy for "Try It Out".
• The API must be published. Learn how to publish your API.

The Try it out button appears only if these two requirements are met.

To test the Try it out button for your API: Discovering APIs in the API Catalog

Troubleshoot for “Try It Out” functionality

Deleting an API from the API Manager Console

To delete an API, you must delete all versions and the assets in those versions. For details, see the following topics:

• Deleting an API Version
• Deleting Version Assets

Related Content

• Version Details
• API Policy Manager
• Setting Permissions in API Manager
• Sample API Specification