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

# Test Connection (/financa5/settings/test)

> La prova con la connessione SALVATA, un passo alla volta: `dns`, `tcp`, `login`, `server`, `read_only`,
`views`, `counts`, `warehouses` (vedi `probe`). Un errore di Financa NON è un errore della rotta (200 con `ok:
false` e il codice del passo). Registra l'esito (`connection`: la riuscita vale 24 ore) e i magazzini letti; se la
connessione cambia durante la prova l'esito si scarta (`recorded: false`).

409, prima di ogni connessione: `financa5.not_allowed` (senza il permesso dell'hub), `financa5.not_configured`
(`data.missing`). 429 oltre 5 prove al minuto per negozio. Audit `financa5.connection_test` con esito e codici
dei passi: mai indirizzi, utente, password o messaggi del driver.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json post /api/v1/admin/financa5/settings/test
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/financa5/settings/test:
    post:
      tags:
        - Integrations & modules
      summary: Test Connection (/financa5/settings/test)
      description: >-
        La prova con la connessione SALVATA, un passo alla volta: `dns`, `tcp`,
        `login`, `server`, `read_only`,

        `views`, `counts`, `warehouses` (vedi `probe`). Un errore di Financa NON
        è un errore della rotta (200 con `ok:

        false` e il codice del passo). Registra l'esito (`connection`: la
        riuscita vale 24 ore) e i magazzini letti; se la

        connessione cambia durante la prova l'esito si scarta (`recorded:
        false`).


        409, prima di ogni connessione: `financa5.not_allowed` (senza il
        permesso dell'hub), `financa5.not_configured`

        (`data.missing`). 429 oltre 5 prove al minuto per negozio. Audit
        `financa5.connection_test` con esito e codici

        dei passi: mai indirizzi, utente, password o messaggi del driver.
      operationId: test_connection_api_v1_admin_financa5_settings_test_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_Financa5TestOut_'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_Financa5TestOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/Financa5TestOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[Financa5TestOut]
    Financa5TestOut:
      properties:
        ok:
          type: boolean
          title: Ok
        tested_at:
          type: string
          format: date-time
          title: Tested At
        checks:
          items:
            $ref: '#/components/schemas/Financa5CheckOut'
          type: array
          title: Checks
        connection:
          $ref: '#/components/schemas/Financa5ConnectionOut'
        recorded:
          type: boolean
          title: Recorded
      type: object
      required:
        - ok
        - tested_at
        - checks
        - connection
        - recorded
      title: Financa5TestOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    Financa5CheckOut:
      properties:
        name:
          type: string
          enum:
            - dns
            - tcp
            - login
            - server
            - read_only
            - views
            - counts
            - warehouses
          title: Name
        ok:
          type: boolean
          title: Ok
        code:
          type: string
          title: Code
        details:
          additionalProperties: true
          type: object
          title: Details
      type: object
      required:
        - name
        - ok
        - code
      title: Financa5CheckOut
      description: L'esito di un passo della prova.
    Financa5ConnectionOut:
      properties:
        checked_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Checked At
        ok_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ok At
        result:
          anyOf:
            - type: string
              enum:
                - ok
                - failed
            - type: 'null'
          title: Result
        fresh:
          type: boolean
          title: Fresh
        server_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Server Version
        engine_edition:
          anyOf:
            - type: integer
            - type: 'null'
          title: Engine Edition
        read_only:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Read Only
        view_counts:
          additionalProperties:
            type: integer
          type: object
          title: View Counts
        warehouses:
          items:
            $ref: '#/components/schemas/Financa5WarehouseOut'
          type: array
          title: Warehouses
      type: object
      required:
        - checked_at
        - ok_at
        - result
        - fresh
        - server_version
        - engine_edition
        - read_only
        - view_counts
        - warehouses
      title: Financa5ConnectionOut
      description: L'ultima prova connessione e i fatti letti (null = mai letti).
    Financa5WarehouseOut:
      properties:
        code:
          type: string
          title: Code
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        active:
          type: boolean
          title: Active
        selected:
          type: boolean
          title: Selected
      type: object
      required:
        - code
        - name
        - active
        - selected
      title: Financa5WarehouseOut
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.