公共模块接入说明

更新时间:2024-05-20 10:30:00

一、模块概述

开趣科技提供一系列公共模块,帮助开发者快速构建应用。通过标准化的接口和 SDK,您可以在几分钟内完成集成。

统一登录

统一登录

支持手机号、验证码、第三方账号等多种登录方式。

用户管理

用户管理

提供用户信息管理、标签分组、黑名单等能力。

数据统计

数据统计

提供实时数据统计与分析能力。

消息通知

消息通知

支持短信、邮件、站内信、模板消息等多渠道通知。

文件存储

文件存储

高可用文件存储与管理,支持上传、下载、预览。

二、接入前准备

  1. 注册开趣科技开发者账号,并完成企业实名认证。
  2. 创建应用,获取 AppKey 和 AppSecret。
  3. 根据业务需求,申请所需模块的使用权限。
  4. 提前服务端域名白名单与回调地址。

三、接入步骤

  1. 选择需要接入的公共模块,阅读对应模块文档。
  2. 配置环境参数,并完成 SDK 初始化。
  3. 调用接口完成登录、同步和数据处理。
  4. 联调测试并上线。

四、示例代码(Web)

import { IOpenClient } from '@iopenfun/web-sdk';

const client = new IOpenClient({
  appKey: 'your_app_key',
  appSecret: 'your_app_secret',
  region: 'cn-hangzhou',
});

const res = await client.auth.login({
  phone,
  code,
});

五、模块与接口对应关系

模块名称主要接口路径接口描述
统一登录POST/auth/login手机号验证码登录
用户管理GET/user/info获取用户信息
数据统计GET/stats/summary获取概览数据
消息通知POST/message/send发送消息
文件存储POST/file/upload文件上传

推荐文档

快速接入指南

快速接入指南

5 分钟快速完成平台接入

API 接口总览

API 接口总览

所有接口的分类与说明

错误码说明

错误码说明

错误识别与处理建议

需要帮助?

提交工单

提交工单

工程师将尽快为您处理

加入开发者群

加入开发者群

与开发者交流,获取最新动态

联系我们

联系我们

工作日 09:30 - 18:30