用户登录
获取登录凭证LoginId,以特定用户身份登录接口系统
| 基本信息
| 信息 | 值 | 备注 |
|---|---|---|
| 接口名称 | 用户登录 | 根据语言别、授权凭证等实现用户登录 |
| 请求状态 | POST | RESTful方式 |
| 接口路径 | http://localhost:23798/api/User/login | 向服务器地址发送POST请求 |
| 远程模式 | http://www.linkerplus.com/api/ext_erp/User/login | 远程模式向服务器地址发送POST请求,需要ERP注册号注册远程模式,并在Headers添加sn参数 |
| 支持日期 | 2018-01-31 | 自该日期起支持 |
| 请求参数
Headers
| 参数名称 | 是否必须 | 参数值 | 备注 |
|---|---|---|---|
| LanguageId | 是 | 0 | 客户端语言别,0:简体 1:繁体 2:英文 |
| Authorization | 是 | Basic REVNT19BRE1JTjoxMjM= | 授权凭证,由账套代号_操作员代号:密码组成字符串的Base64加密值,比如Basic DEMO_ADMIN:123 |
| ClientType | 否 | TestMgr | 用户自定义的客户端识别号,比如客户是WMS系统,可以自定义ClientType=“WMS” |
| Content-Type | 否 | application/json | 用于指定数据的传输类型 |
| Key | 是 | ccd105791a7447e58638b43XXXXXXX46 | 验证注册网上的授权码,请找注册开通使用 |
| sn | 否 | MGR_REST_1001 | 远程模式需添加sn参数,MGR_REST_ERP注册号 |
| 返回数据
| 参数名称 | 类型 | 参数值 | 备注 |
|---|---|---|---|
| LoginId | string | e835943e-55c2-4bf0-832d-6f4166592941 | 返回的LoginId |
| CompNo | string | DEMO | 帐套代号 |
| UserNo | string | ADMIN | 操作员代号 |
| LoginIdExpiry | number | 604800 | 登录超时时间(秒) |
| ClientType | string | WMS | 客户端自定义识别号 |
| LanguageId | number | 0 | 客户端语言别 |
| 调用范例
返回的JSON:
{
"LoginId": "e835943e-55c2-4bf0-832d-6f4166592941", // 返回的LoginId
"CompNo": "DEMO", // 帐套代号
"UserNo": "ADMIN", // 操作员代号
"LoginIdExpiry": 604800, // 登录超时时间(秒)
"ClientType": "WMS", // 客户端自定义识别号
"LanguageId": 0 // 客户端语言别
}
| 备注
以上介绍说的我们向服务器发送POST请求,请求参数是Languageid、ClientType、Key,参数的值根据实际的情况录入,运行后返回LoginId字段的值,通过得出的值,我们可以进行后续调用ERP其他接口的操作。
需要注意
先判断返回的HttpStatusCode是否等于200,如果是则表示调用成功,否则返回错误信息。
登录接口不需要频繁调用,只有当没有获得LoginId或登录已超时后才需要再次调用
登录接口返回的LoginIdExpiry以秒为单位,调用方在调用前先记录本地时间,接口返回后将记录的本地时间以时间戳格式加上LoginIdExpiry的值,即是下次需要再次调用登录接口的时机。
除了登录接口,其它接口调用必须在Headers里面传入LoginId。
返回格式
所有接口都以JSON格式返回