Telenor Sverige Event Subscriber API

openapi: 3.2.0
info:
  title: Event Notification Event Subscriber API
  description: 'API managing registration and notifications of events to subscribers and producers.

    >

    The Event Notification API purpose is to provide real time updates for asynchronous processes at Telenor such as different states for an order or enabling a service in the network. A producer can choose to create an event of a specific category and consumers can choose to subscribe to one, or several, categories. It is also possible to subscribe to all categories if one chooses to. This API is intended for software developers and system integrators implementing client applications for handling events. It is assumed that the reader is familiar with software API concepts such as REST, JSON and the OpenAPI interface specification. For more information about OpenAPI see OpenAPI Specification.

    ### Response Codes

    This API follows standard response codes for REST APIs defined in W3C response codes Note that not all 4xx HTTP Status Codes are explicit documented in each API-operation such as **401 (UNAUTHORIZED)** and **403 (FORBIDDEN)**. These are considered generic ones and clients should be aware their presence at all operations.'
  termsOfService: https://www.telenor.se/globalassets/mediabibliotek/telenor-foretag/pdfer/priser-och-villkor/general-terms-and-conditions-october-2012.pdf
  contact:
    name: Telenor Support
    url: https://www.telenor.se/foretag/kundservice/
  version: 2.1.1
servers:
- url: https://b2bapis-test.telenor.se/
  description: Test environment
- url: https://b2bapis.telenor.se/
  description: Prod environment
tags:
- name: Event Subscriber API
  description: Manages subscriptions and notifications of events using Server-Sent events (eventsource).
  externalDocs:
    description: W3C external documentation of Server-Sent events (eventsource).
    url: https://www.w3.org/TR/eventsource/
paths:
  /event/subscribe/sse:
    get:
      tags:
      - Event Subscriber API
      summary: Starts a Server-Sent Event subscription
      description: 'Starts a subscription between client and server using Server-Sent Events to enable push notifications from Telenor B2B APIs. The state of each event is either

        - IN_PROGRESS

        - PENDING

        - COMPLETED

        - FAILED

        - UNKNOWN


        Below is an example of an event:


        : 0d24ba5b-98ef-4f13-8d58-789c24a58f0a:8

        event: FIXED_NETWORK_PRODUCT_INVENTORY

        id: 79ea335d-6b38-4700-8dc7-1af442f9fb83

        retry: 5000

        data: {"createDateTime":"2021-06-18T15:28:20.4721532+02:00","detailedMessage":"The request is now in progress.","operation":"Provisioning subscription","principal":"902da9e6-4d7c-4bee-ad55-a60ff6b7d994","state":"IN_PROGRESS"}'
      operationId: EventNotificationFacade_startSubscription
      parameters:
      - name: eventCategory
        in: query
        description: The event categories to subscribe to. If parameter is left out in request all event categories will subscribed to. If included, one or several event categories can be specified.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EventCategory'
      responses:
        x-codeSamples:
        - lang: Java
          source: "//Using JAX-RS Client API\nvar client = ClientBuilder.newClient();\nvar target = client.target(url);\ntry (SseEventSource source = SseEventSource.target(target).build()) {\n  source.register((inboundSseEvent) -> System.out.println(inboundSseEvent));\n  source.open();\n};"
        - lang: JavaScript
          source: "var source = new EventSource('https://<base-url>/event/subscribe/sse');\nsource.onmessage = function (event) {\n   alert(event.data);\n};"
        '200':
          description: Subscription started successfully
          content:
            text/event-stream:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  comment:
                    type: string
                  reconnectDelay:
                    format: int64
                    type: integer
                  reconnectDelaySet:
                    type: boolean
                  type:
                    type: object
                  genericType:
                    type: object
                  mediaType:
                    $ref: '#/components/schemas/MediaType'
                  data: {}
                example: ': 0d24ba5b-98ef-4f13-8d58-789c24a58f0a:8

                  id: 123

                  event: FIXED_NETWORK_ORDER

                  data: {"customerId": QUARKUS, "state": "COMPLETED", "operation": "Provisioning","detailedMessage": "The product has now been delivered and ready to use."}'
          x-codeSamples:
          - lang: Java
            source: "//Using JAX-RS Client API\nvar client = ClientBuilder.newClient();\nvar target = client.target(url);\ntry (SseEventSource source = SseEventSource.target(target).build()) {\n  source.register((inboundSseEvent) -> System.out.println(inboundSseEvent));\n  source.open();\n};"
          - lang: JavaScript
            source: "var source = new EventSource('https://<base-url>/event/subscribe/sse');\nsource.onmessage = function (event) {\n   alert(event.data);\n};"
        '401':
          description: Invalid or missing ID Token (JWT)
          x-codeSamples:
          - lang: Java
            source: "//Using JAX-RS Client API\nvar client = ClientBuilder.newClient();\nvar target = client.target(url);\ntry (SseEventSource source = SseEventSource.target(target).build()) {\n  source.register((inboundSseEvent) -> System.out.println(inboundSseEvent));\n  source.open();\n};"
          - lang: JavaScript
            source: "var source = new EventSource('https://<base-url>/event/subscribe/sse');\nsource.onmessage = function (event) {\n   alert(event.data);\n};"
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          x-codeSamples:
          - lang: Java
            source: "//Using JAX-RS Client API\nvar client = ClientBuilder.newClient();\nvar target = client.target(url);\ntry (SseEventSource source = SseEventSource.target(target).build()) {\n  source.register((inboundSseEvent) -> System.out.println(inboundSseEvent));\n  source.open();\n};"
          - lang: JavaScript
            source: "var source = new EventSource('https://<base-url>/event/subscribe/sse');\nsource.onmessage = function (event) {\n   alert(event.data);\n};"
      security:
      - bearer-jwt: []
      x-codeSamples:
      - lang: Java
        source: "//Using JAX-RS Client API\nvar client = ClientBuilder.newClient();\nvar target = client.target(url);\ntry (SseEventSource source = SseEventSource.target(target).build()) {\n  source.register((inboundSseEvent) -> System.out.println(inboundSseEvent));\n  source.open();\n};"
      - lang: JavaScript
        source: "var source = new EventSource('https://<base-url>/event/subscribe/sse');\nsource.onmessage = function (event) {\n   alert(event.data);\n};"
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          description: '## Errors

            ### INVALID_PARAMETERS

            Invalid input parameter(s).

            ### INVALID_JWT

            Invalid ID-token (JWT).

            ### INTERNAL_ERROR

            Internal error.

            ### TIMEOUT

            Timeout occurred when communicating with underlying systems

            '
          type: string
          example: INVALID_PARAMETERS
        message:
          description: Human readable message of the error
          type: string
        timestamp:
          format: int64
          description: timestamp (Epoch) when error occurred
          type: integer
    MediaType:
      type: object
      properties:
        type:
          type: string
        subtype:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        hash:
          format: int32
          type: integer
        wildcardType:
          type: boolean
        wildcardSubtype:
          type: boolean
    EventCategory:
      enum:
      - EVENT_SUBSCRIPTION_STARTED
      - FIXED_NETWORK_ORDER
      - FIXED_NETWORK_PRODUCT_INVENTORY
      - FIXED_NETWORK_QUOTATION
      - FIXED_NETWORK_INTERNAL_CRM
      - HEARTBEAT
      type: string
  securitySchemes:
    bearer-jwt:
      type: http
      description: Telenor Sweden bearer token (JWT)
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: API Operations
  tags:
  - Event Subscriber API
x-servers:
- url: https://b2bapis-test.telenor.se/
  description: Test environment
- url: https://b2bapis.telenor.se/
  description: Prod environment
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/event-notification/openapi
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)