SAP Integration Suite API Products API

openapi: 3.1.0
info:
  title: SAP API Management API Products API
  description: The SAP API Management API enables programmatic management of APIs, products, applications, and developer portals within SAP Integration Suite. It supports creating and publishing API proxies, managing rate plans, configuring policies, administering developer portals, and managing the full API lifecycle within SAP Business Technology Platform.
  version: 1.0.0
  contact:
    name: SAP Support
    url: https://support.sap.com
  license:
    name: SAP Developer License
    url: https://www.sap.com/about/agreements/product-use-and-support-terms.html
  x-logo:
    url: https://www.sap.com/dam/application/shared/logos/sap-logo.svg
servers:
- url: https://{api-portal-host}/apiportal/api/1.0
  description: SAP API Management API Portal
  variables:
    api-portal-host:
      default: my-tenant.apimanagement.sap.hana.ondemand.com
      description: SAP API Management host
security:
- oauth2: []
- basicAuth: []
tags:
- name: API Products
  description: Manage API products bundling multiple APIs
paths:
  /Management/APIProducts:
    get:
      operationId: listAPIProducts
      summary: List API Products
      description: Retrieve all API products available in the API Management tenant.
      tags:
      - API Products
      parameters:
      - name: $top
        in: query
        schema:
          type: integer
      - name: $skip
        in: query
        schema:
          type: integer
      - name: $filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of API products
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/APIProduct'
        '401':
          description: Unauthorized
    post:
      operationId: createAPIProduct
      summary: Create API Product
      description: Create a new API product bundling one or more API proxies.
      tags:
      - API Products
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIProductRequest'
      responses:
        '201':
          description: API product created
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /Management/APIProducts('{name}'):
    get:
      operationId: getAPIProduct
      summary: Get API Product
      description: Retrieve a specific API product by name.
      tags:
      - API Products
      parameters:
      - name: name
        in: path
        required: true
        description: API product name
        schema:
          type: string
      responses:
        '200':
          description: API product details
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    $ref: '#/components/schemas/APIProduct'
        '404':
          description: API product not found
components:
  schemas:
    APIProduct:
      type: object
      properties:
        name:
          type: string
          description: Product name
        title:
          type: string
          description: Display title
        description:
          type: string
          description: Product description
        status:
          type: string
          description: Product status
          enum:
          - PUBLISHED
          - DEPRECATED
          - UNPUBLISHED
        quota:
          type: integer
          description: Request quota per interval
        quotaInterval:
          type: integer
          description: Quota interval value
        quotaTimeUnit:
          type: string
          description: Quota time unit
          enum:
          - minute
          - hour
          - day
          - month
        apiProxies:
          type: array
          items:
            type: string
          description: Names of API proxies included in this product
    APIProductRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Product name
        title:
          type: string
          description: Display title
        description:
          type: string
          description: Description
        apiProxies:
          type: array
          items:
            type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.authentication.sap.hana.ondemand.com/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic