# fasc-openapi-php-sdk

**Repository Path**: fadada-cloud/fasc-openapi-php-sdk

## Basic Information

- **Project Name**: fasc-openapi-php-sdk
- **Description**: 法大大FASC OpenAPI PHP语言版SDK
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: v5.1
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-12-31
- **Last Updated**: 2024-02-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FASC OpenApi PHP SDK v5.1 说明

# 简介

欢迎使用法大大开发者工具套件（SDK），PHP SDK 是法大大电子合同和电子签云服务开放平台（FASC OPEN API）的配套工具。



# 版本说明

FASC.openAPI 产品目前存在两个子版本号：v5.0、v5.1， 均在持续迭代维护。 

当前页面SDK基于FASC.openAPI v5.1子版本开发，如需使用FASC.openAPI v5.0版本SDK，请访问：

https://gitee.com/fadada-cloud/fasc-openapi-php-sdk/tree/v5.0




# 目录结构

- SDK项目层级     
```php
fasc-openapi-php-sdk
	- bean //里面放的是所有接口请求的对象参数
	- client //对应接口各个模块的client，接入方可以参考下面用例初始化client后调用
	- constants //里面放的是接口url地址和应用的配置信息
	- test //里面是接口的调用示例，接入方开发人员可以参考
  	- utils //里面是封装好工具类，接入方开发人员可以参考 
```
- SDK 目前支持以下模块，对应 client 可支持具体的业务方法：

| 模块               | 模块中文名       | 模块说明                                                     |
| ------------------ | ---------------- | ------------------------------------------------------------ |
| Fdd.Service.Client      | 服务访问凭证     | 获取服务访问凭证                                             |
| Fdd.User.Client         | 个人用户管理     | 包含个人用户信息增删改查、认证、授权                         |
| Fdd.Corp.Client         | 企业用户账号管理 | 包含企业用户信息增删改查、认证、授权                         |
| Fdd.Doc.Client          | 文件管理         | 包含文件和附件上传和文件比对、合同智审 |
| Fdd.Org.Client | 组织管理 | 包含部门增、删、改、查和企业成员增、删、改、查 |
| Fdd.Seal.Client | 印章管理 | 包含印章增、删、改、查和免验证签设置等印章原子操作和个人签名查询、个人签名免验证签设置 |
| Fdd.Template.Client | 模板管理     | 包含文档模板列表、文档模板详情查询、签署模板列表、签署模板详情查询               |
| Fdd.AppTemplate.Client | 应用模板管理 | 包含应用文档模板列表、应用文档模板详情查询、应用签署模板列表、应用签署模板详情查询 |
| Fdd.SignTask.Client     | 签署任务管理     | 包含签署任务的创建、维护、各个流程节点的流转操作，以及签署任务文件下载 |
| Fdd.Approval.Client         | 审批管理 | 包含查询审批列表、审批详情、审批链接                         |
| Fdd.Callback.Client         | 回调管理 | 包含查询回调列表，目前仅支持查询审批类型回调                         |
| Fdd.EUI.Client | EUI页面链接管理 | 对EUI页面链接进行管理操作，如个人授权、新企业授权、计费页面链接等 |




# 依赖环境

PHP 7.0.10 版本及以上


# 调用示例      
  接入方初始化一个client，比如调用账号相关，通过client来发起请求。
  ```php
	$userClient = new UserClient(new Client(OpenApiConfigConstants::APP_ID,				            				OpenApiConfigConstants::APP_SECRET, OpenApiConfigConstants::SERVICE_URL));

  ```

  - 获取个人用户授权链接接口示例
```php
	$getUserAuthUrlReq = new GetUserAuthUrlReq();
	# 个人用户在应用中的唯一标识，长度最大64个字符
	$getUserAuthUrlReq->setClientUserId("xxxxx1");
	# 业务请求的个人授权范围列表，多个之间用英文逗号隔开:
	# 查询类：ident_info: 身份信息 signtask_info: 签署任务
	# 管理类：signtask_init: 签署任务创建及发起 signtask_file: 签署文件
	$authScope=["ident_info","signtask_init"];
	$getUserAuthUrlReq->setRequestAuthScope($authScope);
	# 重定向地址,即用户在返回的页面上完成操作后重定向跳转到该地址，并且附带上参数。该地址是应用系统的地址，以实现用户交互在应用系	统和法大大平台之间的连贯性。长度最大500个字符
	$getUserAuthUrlReq->setRedirectUrl(urlencode(""));
	$response = $euiClient->getAuthUrl($accessToken,$getUserAuthUrlReq);
	print_r($response."\n");
```



# 版本更新日志

5.1.0 - 2022-07-28   基于FASC OpenAPI 5.1.0版本开发，初始版本。



# 参考

FASC OpenAPI (服务端) 接口文档 v5.1

https://dev.fadada.com/api-doc/MTE9YIK1SP/QMMRYYN5RMPREAZH/5-1