> ## Documentation Index
> Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List the connectors

> Returns the whole connector catalogue the back-office 'Intégrations' hub steers: payment terminals, e-commerce storefronts, accounting exports and merchandising sync, each with its `key`, display `name`, `category`, `enabled` toggle and `config` map. SECRETS ARE MASKED: every credential-looking config field (apiKey / token / secret / password / …) is returned as the `••••••` sentinel, never its stored value. Use this for orientation before toggling or configuring a connector.



## OpenAPI

````yaml /openapi.json get /v1/integrations
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/integrations:
    get:
      tags:
        - Integrations
      summary: List the connectors
      description: >-
        Returns the whole connector catalogue the back-office 'Intégrations' hub
        steers: payment terminals, e-commerce storefronts, accounting exports
        and merchandising sync, each with its `key`, display `name`, `category`,
        `enabled` toggle and `config` map. SECRETS ARE MASKED: every
        credential-looking config field (apiKey / token / secret / password / …)
        is returned as the `••••••` sentinel, never its stored value. Use this
        for orientation before toggling or configuring a connector.
      operationId: listIntegrations
      responses:
        '200':
          description: The connector catalogue (secrets masked).
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                      minLength: 1
                    name:
                      type: string
                      minLength: 1
                    category:
                      type: string
                      enum:
                        - payment
                        - ecommerce
                        - accounting
                        - merchandising
                    enabled:
                      type: boolean
                    config:
                      type: object
                      additionalProperties:
                        anyOf:
                          - type: boolean
                          - type: string
                  required:
                    - key
                    - name
                    - category
                    - enabled
                    - config
                  additionalProperties: false
                description: The connector catalogue (secrets masked).
                example:
                  - key: shopify
                    name: Shopify
                    category: ecommerce
                    enabled: true
                    config:
                      shopDomain: acme.myshopify.com
                      accessToken: ••••••
                      syncStock: true
                  - key: nepting
                    name: Nepting (Worldline)
                    category: payment
                    enabled: true
                    config:
                      merchantId: M-1024
                      terminalId: T-01
                      apiKey: ••••••
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````