Managing your API Developer Portal

Features of the Developer Portal

You can share the URL to your Org's API Developer to users who do not have credentials to the SnapLogic platform. The Developer Portal enables external users to explore the APIs in your Org. 

Limitation

API versioning is not supported on the Developer Portal that is launched from the Native API Manager. You cannot publish APIs created in the API Management > API Manager console. 


  • Search Filter: Potential API consumers can search the APIs in your Org. The API Label name can be useful in finding the relevant APIs.
  • API Info Tab: Displays the information about the API.
    • Name: Name of the API
    • Description: The description of the API entered by the publisher.
    • Administrator Email: Org admin
    • Authentication Policies: Type of authentication policy that the API uses.
    • Base URI: The true URI element.
    • Base Path: The main part of the API endpoint.
  • API Details: Displays information about the way the API is called.
    • Base URL: The actual endpoint URL used as the API.
    • Search: A search field where API consumers can enter key-terms.
    • Request Type and Path: The HTTP method and endpoint.
    • Parameters: The name and description of the supported parameters you can use with the API.
    • Response Schema: The HTTP response code, description, and example data for the API. 

API Developer Portal Requirement

You must have at least one published API in your Org's Developer Portal. The link to the Portal directs to an HTTP 404 error page if no Published Task APIs exists or if a user incorrectly enters the URL.


Customizing the Developer Portal for your Org

To customize the banner image and text:

  1. Log into SnapLogic, click Manager > Native API Manager.
  2. Click the Customize Portal tab:
  3. Modify the image (upload and replace the existing image):
    1. Click Choose Logo, then navigate to a target folder in your system and select an image.
      • Maximum File Size: 10MB
      • Supported File Formats: JPG, PNG, or SVG.
      • Dimensions: not more than 125 pixels by 50 pixels.
    2. Verify the image in the Preview, then click Save.
  4. Modify the text:
    1. Click Update Text, and in the displayed blank field, enter the banner text for your Developer Portal. You can delete or write over the current text.
      • Maximum length: 90 characters.
    2. Review your updated banner text, then click Save.
      • To revert to the default image or text, click Default, then click Save.
      • To revert back to the current Developer Portal banner and image, click Reset, then click Save.


Publishing an API to the Developer Portal

  1. Log into SnapLogic, click Manager > Native API Manager, and from the Project dropdown list select your target project or project space.



  2. From the returned list of APIs, click Publish for the target API:



    The API Publish dialog appears.

  3. Complete the Publish API dialog by entering the following information and clicking Publish:
    • Public API Label: Required A public name for your API for the Developer Portal. If left blank, the default label uses the name of the underlying Task.
    • Public API Description: a summary of what your API does.
    • Contact Email: An email to which API consumers can send feedback or questions about using the API.



  4. Click Developer Portal to verify that API is published.

Republishing an API to the Developer Portal

  1. Improve your API based on analysis using the API Dashboard. With the results, you can modify the underlying Pipeline or the policies set for that API.
  2. Log into SnapLogic, click Manager > Native API Manager, and from the Project dropdown list select your target project or project space.
  3. From the returned list of APIs, click Republish for the target API. You can only republish APIs that are Published.
  4. Click Developer Portal to verify that API is Republished.

Unpublishing an API to the Developer Portal

  1. Log into SnapLogic, click Manager > Native API Manager, and from the Project dropdown list select your target project or project space.
  2. From the returned list of APIs, click Unpublish for the target API. You can only unpublish APIs that are Published.
  3. Click Developer Portal to verify that API is unpublished.

Accessing the API Developer Portal

  1. Log into SnapLogic, navigate to Manager > Settings, then click Native API Manager.
  2. On the right, click on Developer Portal. The Developer Portal for that Org is displayed.