labelixa-com Fonts API

openapi: 3.2.0
info:
  title: Labelixa Com Fonts API
  version: 0.4.0
  description: 'Operations tagged Fonts across 2 of this provider''s published API definitions: labelixa-com-api-openapi.json, labelixa-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Fonts
paths:
  /v1/fonts:
    post:
      summary: Convert font to ZPL
      description: Converts a TrueType/OpenType font (multipart `file`, up to 4 MB) to a ZPL `~DU` font download command; call it in ZPL with `^A@`. `?chars=` subsets the font to those characters (up to 2000) to shrink the output. `X-Font-Name` and `X-Drive` set the stored name and drive. Counts as one operation.
      operationId: font_to_zpl_v1_fonts_post
      parameters:
      - name: chars
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Chars
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_font_to_zpl_v1_fonts_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Fonts
  /v1/fonts/library:
    post:
      summary: Upload font to account
      description: Uploads a font into the account's font memory (virtual printer memory); it is prepended automatically to renders that use `^A@`. Same validation as `POST /v1/fonts` (name and drive rules, 4 MB, `chars` limit) and the same operation count. Requires an account on Starter or above. 201 on success, 409 when the font memory rejects it.
      operationId: font_bellek_yukle_v1_fonts_library_post
      parameters:
      - name: chars
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Chars
        description: 'Optional: subset the font to these characters (up to 2000).'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_font_bellek_yukle_v1_fonts_library_post'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Fonts
    get:
      summary: List account fonts
      operationId: font_bellek_listesi_v1_fonts_library_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      description: Lists the fonts stored in the account's font memory. Requires an account on Starter or above.
      tags:
      - Fonts
  /v1/fonts/library/{ad}:
    delete:
      summary: Delete account font
      operationId: font_bellek_sil_v1_fonts_library__ad__delete
      parameters:
      - name: ad
        in: path
        required: true
        schema:
          type: string
          title: Ad
        description: Font name as stored (e.g. `FONT.TTF`).
      - name: surucu
        in: query
        required: false
        schema:
          type: string
          default: 'R:'
          title: Surucu
        description: Printer drive the font is stored on (default `R:`).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Removes a font from the account's font memory; `ad` is the font name. 204 on success, 404 when not found. Requires an account on Starter or above.
      tags:
      - Fonts
  /v1/fonts/embed:
    post:
      summary: Embed font into ZPL
      description: 'Embeds a font into a ZPL document: adds the `~DU` download and binds the `^A0` fields to it with `^A@`, so the output no longer depends on the printer''s ROM font. The font is subset to the characters used on the label. Multipart `file` (font, up to 4 MB) and `zpl` (up to 1 MB). Counts as one operation.'
      operationId: font_embed_v1_fonts_embed_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_font_embed_v1_fonts_embed_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Fonts
  /v1/fonts/kalibrasyon:
    get:
      summary: Font calibration scores
      description: Scores the installed fonts by how closely they match Zebra font 0 metrics (the Zebra font is proprietary, so the closest open font is found by measurement). Useful when choosing `LABELIXA_FONT` on an on-premises installation.
      operationId: font_kalibrasyon_v1_fonts_kalibrasyon_get
      parameters:
      - name: kat
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Kat
        description: 'Optional width coefficient: score only the default font with this value.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Font Kalibrasyon V1 Fonts Kalibrasyon Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Fonts
  /v1/fonts/inspect:
    post:
      summary: Inspect fonts
      description: 'Font report for a ZPL label: which fonts each field uses and their physical size. Stateless: the code is not stored or logged. Does not count against the operation quota; only the per-second rate limit applies. Field text in the report is truncated to 40 characters. `dpi` is optional; without it a unique density estimate is used, and if none exists the millimetre column is empty and the reason is given.'
      operationId: fonts_inspect_v1_fonts_inspect_post
      parameters:
      - name: dpi
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Dpi
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Fonts
components:
  schemas:
    Body_font_bellek_yukle_v1_fonts_library_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_font_bellek_yukle_v1_fonts_library_post
    Body_font_to_zpl_v1_fonts_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_font_to_zpl_v1_fonts_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_font_embed_v1_fonts_embed_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        zpl:
          type: string
          title: Zpl
          default: ''
      type: object
      required:
      - file
      title: Body_font_embed_v1_fonts_embed_post
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json