# Messaging Hub

**Repository Path**: yywill/Messaging-Hub

## Basic Information

- **Project Name**: Messaging Hub
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-29
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RESTAPIDocs For Messaging Hub

API Document for Messaging Hub 

2 User Cases

1. sending message via interal systems to inform users
1. user retrive message historys(InBox Messages)
   * NOTE: Only Selected Messages will be stored in inbox 

## Common Endpoints(Shared Modeule)

SSO API is our basic module for all Authentication needed APIs. Please Refer to [SSO](https://jwt.io/) Documents.

### Open Endpoints

Open endpoints require no Authentication.

* [Login](https://notimplement.com) : `POST /api/login/`

### Endpoints that require Authentication

Closed endpoints require a valid Token to be included in the header of the
request. A Token can be acquired from the Login view above.

## Message Hub Related

Endpoints for viewing and manipulating the Accounts that the Authenticated User
has permissions to access.

* [Show Inbox Messages](messages/get.md) : `GET /2c/api/message/inbox/`
* [Send a Message](messages/post.md) : `POST /internal/api/message/`

__Notes:__ 

Batch sending is NOT ALLOWD in System Integration level, but can be done in our Ops Center(Task Platform). Futhermore, BATCH APIs shall be provided by [Batach API](http://www.baidu.com)