了解如何使用 Smile API 进行跨平台数据访问和管理。
关于 Smile
您好，欢迎来到 Smile！
Smile 通过单一的 API 提供跨平台、跨雇主和跨文档的身份、收入和就业数据。银行、金融科技公司、招聘机构以及其他服务提供商可以利用就业与收入数据来提升用户采用与转化、降低成本并降低风险，而这一切都可通过单一的 API 实现。
数据访问由用户本人授权，这是我们所提供 API 的一部分。我们提供了一种机制，您的用户可以通过该机制同意收集其个人数据，并将其安全地传输给您或其信任的任何第三方。整个过程简单、安全且无缝。
根据您可用的输入与预期的输出，Smile API 的产品可以帮助您更好地了解您的客户（KYC）。
我们的 API
Smile API 基于 RESTful 原则构建。所有请求与响应载荷均采用 JSON 格式。出于安全考虑，所有请求必须通过 HTTPS 发送。要获取 API 访问权限，您需要先注册我们的开发者控制台。
要进一步了解我们的 API，请参阅第 2 章《了解 API》。
使用开发者控制台
要开始使用，只需在开发者控制台上注册。注册后，系统会提示您验证邮箱，通过验证后即可登录。
默认情况下，注册并登录后，您将处于“Sandbox（沙盒）”模式，返回的仅为测试数据。您可以通过预约电话或联系我们，并提交上线所需信息以获取“Production（生产）”模式的访问权限。
注意想了解不同模式的详细信息，请查看下一节 “了解 API”。
在开发者控制台中，您将看到以下内容：
-
账户使用情况： 查看账户使用情况，例如组织内已连接的账户数与用户数。
-
Wink Widget： 包含使用 Smile 账户连接 SDK（Wink Widget）所需的一切。Emulator（模拟器） 允许您体验 Wink Widget 的工作方式。在 Sandbox 模式下，您可以使用页面提供的测试账号来模拟登录不同的数据提供方（如零工平台或薪资系统）。在 Production 模式下，您可以实际连接真实账号或上传真实文件。您还可以在该部分管理您的 Wink 模板与 Wink 站点。
-
Snap 文档： 您可以在此试用或使用 Smile Snap，Sandbox 模式可上传示例文件，Production 模式可上传真实文件。每个文件的处理状态与输出都可在该页面直接查看。
-
Signal 请求： 在此可测试多种 Smile Signals 服务，例如 Signals、Verifications、Blacklists、Digital Footprint 与 Multiple Application Warning。
-
用户数据： 查看后端创建的用户以及在账户连接或文件上传过程中采集到的数据。您还可以预览 Smile 返回的各资源（如就业与收入）的数据结构与示例。
-
集成： 包含帮助您接入 Smile Network 的各类工具：了解不同的数据源、生成与管理API Keys 与 Webhooks，以及配置授权（Consent）模板。
在页面右上方的顶栏导航中，您还可以管理组织与账户设置、服务状态与可用性，以及当前正在阅读的 API 文档。
使用本参考文档
为了完整体验 Smile API，我们建议您在参考文档页面右侧输入您的 API Key 与 Secret，以充分利用本参考站点的交互功能。
注意您可以登录开发者控制台，在API Keys 部分找到您的 API Key 与 Secret。注册后，您将立即免费获得 Sandbox 环境的测试权限；如需 Production 环境访问，请联系我们。
您可点击 API Key 与 API Secret 旁的复制图标，快速复制到剪贴板。
额外资源
我们在下方提供一些开源资源，帮助您立即开始使用 Smile API！
API 规范
注意
git clone https://github.com/SmileAPI/smile-openapi规范文档为 YAML 格式，遵循 OpenAPI Specification 3.0.0。您也可在 /docs 子目录下下载本开发者文档的 Markdown 离线副本。
Postman 集合
注意在 Github 上下载 Smile API 的 Postman 集合。如果您安装了 git，您可以克隆该仓库或运行以下命令：
git clone https://github.com/SmileAPI/smile-openapi您可以下载 JSON 格式 的 Postman 集合并导入 Postman，轻松开始审阅与测试我们的 API。