API information

API information

The <api_info> XML element provides version details and a list of supported fonts available on the system. This information helps client applications verify compatibility and ensure valid input for lettering decorations.

XML structure

<api_info>                   <!-- Root element for API metadata -->
  <api_version
    major="1"               <!-- Major API version -->
    minor="5"               <!-- Minor API version -->
    build="2"                 <!-- Build number -->
    private="0"             <!-- Internal/private versioning number -->
  />
  <alphabets>             <!-- List of supported lettering alphabets -->
    <alphabet name="Block1" />        <!-- Alphabet name -->
    <alphabet name="Block2" />
    <alphabet name="London" />
    <alphabet name="Alice" />
  </alphabets>
  <full_version>            <!-- Full version info including internal versions -->
    <api_version 
      major="1" minor="5" build="2" private="0" 
    />
    <internal_api_version 
      major="2" minor="2" build="2" private="0" 
    />
  </full_version>
</api_info>

Usage

The api_info XML is returned by the api/info method. Client applications can use this information to:

  1. Confirm which version of the API they are interacting with.
  2. Validate that requested features are compatible with the current version.
  3. Retrieve the list of available fonts for creating valid lettering decorations.

Elements

✅<api_info>

Root element. Encapsulates API versioning and supported alphabet data.

    ✅<api_version>

    Specifies public API version information:
    Attribute
    Details
    major
    Major version number.
    minor
    Minor version number.
    build
    Build number for incremental releases.
    private
    Private version number (internal use).

    ✅ <alphabets>

    Contains one or more <alphabet> elements.
    1. Each specifies the name of a supported font used for lettering decorations.
    2. Font names must be supplied exactly as returned, including any spaces — e.g. 'Block Sans'.
    3. Must match exactly when used in input.

    ✅ <full_version>

    Provides extended version details, including:
    1. A duplicate api_version — same structure as above.
    2. An internal_api_version used for internal or support-related purposes.

    Remarks

    1. The api_info ensures that the client knows exactly which fonts can be used for lettering decorations.
    2. The list of fonts returned defines what lettering decorations the API can generate — only fonts returned by this element are supported.
    3. Font names must be supplied exactly as listed in this XML — case-sensitive, including any spaces.
    4. The full_version provides additional versioning for support/debugging use.
    5. The structure may be extended in future API versions.

    InfoAlways check api_version and the available fonts before submitting a design request that includes lettering.