平台发布接口（OrBitWebAPI&OrBitWebAPI2） - .Net 平台应用与技巧

# 1、概述
  在项目实际应用过程中，有时MOM系统需要与第三方系统交互，系统支持可提供标准WebAPI服务供第三方系统调用，以达到数据互通有无。我们平台提供了OrBitWebAPI、OrBitWebAPI2两大发布接口，OrBitWebAPI2为最新版，支持Raw数据提交。
  
  
# 2、步骤
2.1 获取加密票（支持GET、POST）。可选（WCF可配置关闭，建议开启）
2.2 提交数据（支持GET、POST，强烈建议用POST）

# 3、OrBitWebAPI
#### 3.1 获取加密票
**3.1.1 GET方式**

![](/media//202304/2023-04-28_095054.png)

**3.1.2 POST方式，表单**
![](/media//202304/2023-04-28_095015.png)

#### 3.2 提交数据
**3.2.1 GET方式**

![](/media//202304/2023-04-28_100236.png)

**3.2.2 POST方式，表单**

![](/media//202304/2023-04-28_100543.png)

# 4、OrBitWebAPI2
#### 4.1 获取加密票
**4.1.1 GET方式**
与OrBitWebAPI一样

**4.1.2 POST方式，表单**
与OrBitWebAPI一样

**4.1.3 POST方式，通过Header**

![](/media//202304/2023-04-28_095933.png)

**4.1.4 POST方式，通过Raw-Json**
![](/media//202306/2023-06-05_094445.png)
```json
{
    "UserName":"HH0102",
    "UserPassword":"s11111111a"
}
```

#### 4.2 提交数据
**4.2.1 GET方式**
与OrBitWebAPI一样

**4.2.2 POST方式，表单**
与OrBitWebAPI一样

**4.2.3 POST方式，Raw**
**1) Header**。注意：如果加密票不需要，则不用写UserTicket；UserParameter可以用来传一些附加参数，一般不用。
![](/media//202304/2023-04-28_100848.png)
**2)body-Raw**。参数@UserData接收
![](/media//202304/2023-04-28_101118.png)

**4.2.4 POST方式，Raw--Json**

![](/media//202306/2023-06-05_095831.png)
```json
{
    "API":"Demo",
    "OutType":"Json",
    "UserTicket":"D5B4AC89A4191ED9A990ABB56F3E3EBE164715131AB9D32D2C06B7783457EBF6F16E664BE8BE90DD206DBCC7B22AA0F36111B4A81963929B184DD0AA36135771FC57B7D4205DB3D7",
    "UserParameter":123,
    "UserData":{"Root":[{"BillId":"BILL00000002","BillId":"BILL00000002","BillHeader":"1A1","BillCounter":4},{"BillId":"BILL00000003","BillId":"BILL00000003","BillHeader":"1C1","BillCounter":1}]}
}
```

说明：
UserParameter：可以是数字、字符串、Json
UserData：可以是数字、字符串、Json

# 5、接口参数 以及对应 存储过程的关系
#### 5.1 API 参数：
1、返回数据类型：OutType。对应值为JSON、XML、空（""，即不写）。
	a、指定为JSON、XML时，接口按平台固定格式返回；
	b、指定为空，即不写，此时前端接收到的是返回的第1行第1列的值，主要用于"定制化的JSON、XML格式"，通过在存储过程里把数据转换需要的JSON、XML格式，在发挥。
2、后台存储过程名称：API
3、输入参数名称：UserParameter
4、输入参数名称：UserData
5、加密票名称：UserTicket

#### 5.2 存储过程：
@ResourceName 参数无实际意义，忽略此参数
```
-- =============================================
-- Author:        <OrBit Team Orbchay HH0102 >
-- Create date:   <2020/07/14 14:49:07:3417>
-- Description:   <送货单 之 选择 采购订单 值列表>
-- Rev: 15.00
-- Update comment:
-- Update date:
-- =============================================
ALTER PROCEDURE [dbo].[WebAPI_VendorDelivery_GetPO_Script]
@OrBitUserName NVARCHAR(100) = '' ,
@ResourceName NVARCHAR(100) = '' ,
@UserParameter NVARCHAR(MAX) ,
@UserData NVARCHAR(MAX) = ''
AS
BEGIN
	-- SET NOCOUNT ON added to prevent extra result sets from
	-- interfering with SELECT statements.
	-- 为了避免SQL注入攻击，尽可能避免以“拼接字符串”方式动态执行SQL语句

SET NOCOUNT ON;
	SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED
	
	SELECT 
		@OrBitUserName AS OrBitUserName,
		@UserParameter AS UserParameter,
		@UserData AS UserData
END
```