1nce/openapi/1nce-product-information-openapi.yml at main · api-evangelist/1nce · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
openapi: 3.0.1
info:
  title: Product Information
  description: Documentation of the 1NCE API for Product Information
  contact:
    name: 1NCE GmbH
    url: https://1nce.com
    email: info@1nce.com
  version: v1.2
servers:
- url: https://api.1nce.com/management-api
tags:
- name: Products
  description: Product Information
paths:
  /v1/products:
    get:
      tags:
      - Products
      summary: Get All Products
      description: Get a list of all avaliable products.
      operationId: getProductsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product'
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product'
        '401':
          description: Unauthorized
          content: {}
        '403':
          description: Forbidden
          content: {}
        '404':
          description: Not Found
          content: {}
      deprecated: false
      security:
      - BearerAuthentication: []
components:
  schemas:
    Charge:
      title: Charge
      type: object
      properties:
        name:
          type: string
          description: Name of the charge.
          example: provisionCharge
        amount_net:
          type: number
          description: Net amount of the charge.
          example: 10
        currency:
          type: string
          description: Currency of the charge.
          example: EUR
      description: Charging price for a product or service offered by 1NCE.
    Product:
      title: Product
      type: object
      properties:
        id:
          type: integer
          description: Product id, unique identifier for the product.
          example: 1001
        product:
          type: string
          description: Specific name of the 1NCE product.
          example: 1NCE IoT FlexSIM - Standard
        material:
          type: string
          description: Product type specification.
          example: 1NCE FlexSIM
        package_size:
          type: integer
          description: Quanitity of product in one package.
          example: 1
        minQuantity:
          type: integer
          description: Minimum quantity of product per order.
          example: 1
        maxQuantity:
          type: integer
          description: Maximum quantity of product per order.
        maxQuantityPerCustomer:
          type: integer
          description: Maximum quantity of product per customer.
        min_contract_duration:
          type: integer
          description: Minimum contract duration for the given product in months.
          example: 120
        one_time_charges:
          type: array
          description: One-Time charges that apply for this product.
          items:
            $ref: '#/components/schemas/Charge'
        recurring_charges:
          type: array
          description: Recurring chargesthat apply for this product.
          items:
            $ref: '#/components/schemas/Charge'
      description: Information about a specific 1NCE product.
  securitySchemes:
    BearerAuthentication:
      type: http
      scheme: bearer
      description: Bearer Authentication Token used to gain access to the 1NCE API. Please refer to the Open Authorization
        (/oauth/token) request for obtaining a Bearer Token.
x-readme:
  explorer-enabled: true
  proxy-enabled: true