Table of Contents

Supporting Interfaces

API Client

Interface: interface "PIMX API Client"
Enum: enum 70113760 "PIMX API Type"

When to use

Use this interface when you need to add a publication API client that sends a publication queue record to an external service. The client implementation is selected through the API type and is used by publication export processing.

HIDDEN

DevOps sources: #15008

Authentication Token

Interface: interface "PIMX Authentication Token"
Enum: enum 70113758 "PIMX Auth Type"

When to use

Use this interface when an integration needs to apply a selectable authentication method to an HTTP request. The authentication type is selected by the integration and the implementation can set credentials, refresh or validate a token, and add authorization to request headers or the URL.

HIDDEN

DevOps sources: #9285, #6271

File Repository

Interface: interface "PIMX File Repository c4"
Enum: enum 70113726 "PIMX Document Repository Type"

When to use

Use this interface when you need to connect Pimics to a document repository or add a repository implementation. The repository type is selected in document and domain repository setup, where the implementation provides container selection, file search, content and thumbnail retrieval, links, and repository file operations.

HIDDEN

DevOps sources: #23067, #22688, #35838

Publication Update Line

Interface: interface "PIMX Publication Update Line c7"
Enum: enum 70113732 "PIMX Publication Data Type"

When to use

Use this interface when a publication channel needs custom logic while publication lines are created or updated. The implementation is called during publication reorganization for items, variants, categories, documents, features, keywords, texts, and cross-references, and the publication data type selects the implementation for a channel.

HIDDEN

DevOps sources: #20665, #20666, #36818

Translation API

Interface: interface "PIMX Translation API c1"
Enum: enum 70113775 "PIMX Translation API Type"

When to use

Use this interface when you need to connect a translation provider or add provider-specific translation and glossary behavior. The translation API type selects the implementation used when Pimics translates plain text or HTML, and the current interface also supports glossary discovery and glossary-entry maintenance.

HIDDEN

DevOps sources: #43139, #6739