publiq Vouchers API

openapi: 3.2.0
info:
  title: museumPASSmusées Partner Vouchers API
  version: '1.0'
  description: With the museumPASSmusées Partner API you can look up the card of a passholder and check if they are allowed to visit your museum and register their visit so your museum gets reimbursed for it.
  contact:
    name: publiq helpdesk
    email: technical-support@publiq.be
    url: https://docs.publiq.be
servers:
- url: https://partner-api-test.museumpassmusees.be
  description: Testing
- url: https://partner-api.museumpassmusees.be
  description: Production
tags:
- name: Vouchers
paths:
  /voucher-lists:
    parameters: []
    post:
      x-internal: true
      summary: Generate a list of vouchers
      operationId: post-voucher-lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoucherList'
              examples: {}
        '400':
          description: 'Bad Request. Possible error types:


            * https://api.publiq.be/probs/body/missing

            * https://api.publiq.be/probs/body/invalid-syntax

            * https://api.publiq.be/probs/body/invalid-data'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      description: 'Generate a list of vouchers for the partner identified by the client access token.


        Vouchers may sold to new or existing passholders so they can register a new pass or extend their current subscription on https://www.museumpassmusees.be.


        > **All vouchers generated in the _production_ environment will be invoiced to the partner.** Vouchers generated in the _test_ environment will **not** be invoiced.


        ## Permissions


        The caller of this request must have the `voucher generator` role for the partner.'
      security:
      - CLIENT_ACCESS_TOKEN: []
      requestBody:
        description: Amount of new vouchers to generate for the new list.
        content:
          application/json:
            schema:
              type: object
              properties:
                numberOfVouchers:
                  type: integer
                  minimum: 1
                  maximum: 10
                  description: The total number of vouchers to generate
              required:
              - numberOfVouchers
            examples:
              Example:
                value:
                  numberOfVouchers: 1
      tags:
      - Vouchers
components:
  schemas:
    Error:
      $ref: https://raw.githubusercontent.com/cultuurnet/apidocs/main/projects/errors/models/Error.json
      x-internal: true
    VoucherList:
      title: VoucherList
      type: object
      examples:
      - id: a6c002ca-41ee-4e02-9558-1bead1b54ebc
        vouchers:
        - '5454482138103'
        - '5428704143561'
        - '5458143034508'
      properties:
        id:
          type: string
          format: uuid
          description: ID of the voucher list. This ID can be used for logging purposes.
        vouchers:
          type: array
          description: List of vouchers.
          items:
            type: string
            minLength: 13
            maxLength: 13
            minItems: 1
            maxItems: 10
      required:
      - id
      - vouchers
      x-internal: true
  responses:
    Forbidden:
      description: 'Forbidden. Your request was successfully authenticated but you do not have permission to perform this particular request.


        * type: https://api.publiq.be/probs/auth/forbidden

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/forbidden
                title: Forbidden
                status: 403
                detail: user must be admin of organizer abcd1234
    Unauthorized:
      description: 'Unauthorized. Your request is missing the required credentials to authenticate. See the Authentication documentation for more info.


        * type: https://api.publiq.be/probs/auth/unauthorized

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/unauthorized
                title: Unauthorized
                status: 401
  securitySchemes:
    CLIENT_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A client access token, obtained by exchanging your client id and client secret for a token via an HTTP request to publiq's authorization server using the **Client Credentials OAuth Flow**. See the [authentication docs about client access tokens](https://docs.publiq.be/docs/authentication/methods/client-access-token) for more info.