Customer Management Biz Api icon

Customer Management Biz Api

2.0.x
(0 reviews)

Brief Description

The following document is the specification of the REST API for Customer Management. It includes the model definition as well as all available operations.

It provides a standardized mechanism for customer and customer account management such as creation, update, retrieval, deletion and notification of events.

Customers can be a person, an organization or another service provider who buys products from an enterprise. Customer management API allows the management of identification and financial information about him.

Customer management API manages the following data resources:
  • Customer
    • Customer represents a person or organization that buys products and services from the enterprise or receives free offers or services. Customers can also be other service providers who resell the enterprise's products, other service providers that lease the enterprise's resources for utilization by the other service provider's products and services, and so forth.
    • Customer resource contains information about the customer. Main attributes are its identifier, name, status and validity, description, characteristics, contact medium, related customer account, related party, customer credit profile information
The customer management API performs the following operation on the customer:
  • Retrieval, creation, full or partial update and deletion of customers.

Criticality

Medium

Layer/Category

Process

API Current State

Testing Phase

Usage

TBD

Base URI Summary of Methods

  1. Development:
  2. TEST:
  3. PREPROD:
  4. PROD:

Transport Protocol(s)

HTTP

HTTPS

3 Layer architecture flow diagram

Sequence Diagram

TBD

Quality of Service (QoS)

TBD

Avg. Response Time (Secs)

TBD

Avg. Payload Size (KB/MB)

TBD

Max Payload Size (KB/MB)

TBD

Avg. Volumes (per day)

TBD

Peak Volumes

TBD

Peak Volumes Timespan

TBD

Availability

High Availability

Service Level Agreement

N/A

Policies

N/A

GDPR

TBD

Constraints

There are no constraints applicable to this API.

Assumptions

Average/Peak Response time depends on the size of payload and speed and other network and processing factors.

Reference documents

Reviews