Partner Input API

Introduction

The Input API serves as a critical bridge between partners and the core digital document management system, streamlining the process of identifying customers and delivering digital documents efficiently. This API is designed to enhance operational efficiency and user experience by providing two key endpoints: lookup and delivery. The lookup endpoint allows partners to search for customer information to ensure accurate document delivery. Once a match is found, the delivery endpoint is used to securely send digital documents directly to the identified customer's inbox.

This diagram illustrates the flow from a partner initiating a customer lookup to the final delivery of documents into the PEAX-Core system.

Domain Model

The domain model for the Partner Input API illustrates the structure and relationships between various entities involved in the API's operation. Key components include:

PartnerInput: The main entity representing the input from partners, including details like document type, title, and references to sender and receiver.

PartnerInputSuccess: Represents a successful input operation, including identifiers for tracking and reference.

ObjectSender and ObjectReceiver: Detail the sender and receiver's information, respectively, including identifiers and contact details.

UserLookUpInput: Specifies criteria for user lookup operations, including personal information and a quality level for the search.

LookUpRequestsView and LookUpResult: Used for displaying lookup request results, including user identifiers and basic information.

ApiErrorView: Captures error information, potentially including detailed error messages and associated data.

ExceptionDetail and Info: Provide additional error details and general information about the operation or error state.

Process Model

This diagram outlines the primary process flow within the Partner Input API:

Submit PartnerInput: The partner submits data to the Partner Input API.

Validate Input: The API forwards the data to the PEAX-Core System for validation.

Input Validated: If the input is valid, the process continues to store the data.

Store Input Data: Valid input data is stored in the database.

Data Stored: Once the data is successfully stored, a success response is sent back to the partner.

Validation Failed: If the input is invalid, the API immediately returns an error response to the partner.

This sequence ensures efficient data handling, validation, and feedback within the Partner Input API process.

Overview

Partner Input API#

Introduction#

Domain Model#

Process Model#

Partner Input API

Introduction

Domain Model

Process Model