Import an API definition for an external API

Prerequisites

  • For Planet 9 files: you must have previously exported a Planet 9 file of an API definition from the API Designer of your Neptune DXP - Open Edition system for the API Designer to recognize the Planet 9 file during import.

Procedure

  1. In the Cockpit, select the API Designer.

    Result: A table of existing API definitions is shown.

  2. Select Add.

    Result: You start in the General tab.

  3. In Type, select External.

  4. In API Format, ensure that you set the API format in accordance with the format supported by your API server.

  5. In Name, enter a meaningful name for the API.

  6. In Endpoint, add the URI for the endpoint.

  7. Select Save.

  8. Select Import and select an option from the drop-down menu:

    1. To import a file from your disk, select Planet 9 File.

      Result: Your local file explorer opens.

      1. Go to the directory of the file, select the file, and select Open.

    2. To import a definition in JSON or YAML, select Open API 3.0.

      Result: The Import API dialog opens.

      1. Write or paste the definition into the editor.

      2. Select Import.

    3. To import an API from the connected API Factory of a remote system instance of the Neptune DXP - SAP Edition, select SAP api.

      Result: The Import API dialog opens. You can see all APIs that are available to you.

      1. Select the API that you want to import, select either JSON or YAML, and select Import.

        Result: The API Designer enters a name, operations, and definitions for the API. You can still add, change and delete settings that were made by the API Designer.

    4. To import an API from a remote system instance of the Neptune DXP - SAP Edition or another remote system via the API Discovery Service, select API Discovery Service.

      Result: The API Discovery Service dialog opens and existing remote systems in the API Discovery Service are shown.

      1. Select the relevant remote system and the API that you want to import.

        Result: The selected API endpoint is entered automatically in the Endpoint field.

      2. Select Import.

Result

  • You have imported an API definition for an external API according to your chosen import method.