use:guide

新手引导

概述

企业QQ开放平台,基于腾讯开放平台构建,提供企业QQ业务API接口。帮助合作伙伴开发商和企业QQ用户访问企业QQ的数据,实现数据同步、互通等需求,以便在此基础上实现合作伙伴产品和企业QQ产品的无缝整合。除此之外,企业QQ的用户,如果需要将企业原有的内部系统和企业QQ进行整合,也可以利用企业QQ开放平台提供的API。

本教程为新手引导教程,面向读者为:合作伙伴开发商开发人员,以及企业QQ用户企业中的IT技术研发人员

成为企业QQ的开发者,并注册App

如何成为合作伙伴开发商

合作伙伴开发商,是指,提供某种企业级服务或者某种企业应用软件的企业。通过跟腾讯企业QQ建立合作关系后,可以成为合作伙伴开发商。建立合作伙伴关系后,可以享有一些权利,包括但不限于技术支持,免费获得测试用的企业QQ号码,以优惠的价格使用腾讯云平台的服务器用于部署其服务或者产品。

成为合作伙伴开发商,需要联系企业QQ产品的商务经理,先进行商务层面的洽谈。

如何成为用户开发者

用户开发者,是指企业QQ的用户,自身具备研发能力,使用企业QQ的开放API,将企业原有IT系统和企业QQ产品进行整合。成为用户开发者仅需要购买企业QQ号即可。然后,登录企业账户中心,访问开发者模式页面,即可以申请AppID了。

申请调用企业qq的开放api

如何注册并获得App Id和App Secret

要调用企业QQ开放平台API,首先要注册App ID,此ID是一个App在系统中的唯一标识符。也是App在系统中的身份ID,用于API接口的鉴权。App Secret是与App ID相对应的密钥。App的开发者有义务保护好申请到的App Secret避免自己的和用户的数据因此遭受的安全威胁。通过企业账户中心的开发者模式页面申请App ID,申请通过后,就可以在此页面看到您的App ID和App Secret值。

申请App完毕后,开发调试

新手接入开放平台的步骤

申请完App ID后,就可以开始调试和开发工作了,首次接入,可以按照如下图示建议的步骤进行操作:

首次接入开放平台的操作步骤图

上图中,绿色的,代表到目前为止,您应该已经完成的步骤。后续,按照下列步骤操作即可。

1、填写企业授权回调地址

2、开发后台代码

我们有简单的后台代码( 参考oauth授权代码)以及详细的后台代码可以参考( 范例代码

3、进入企业QQ账户中心,点击开通即可

FAQ

企业授权回调地址、员工回调地址和事件通知地址的区别?

  • 企业回调地址:用作企业oauth授权,主要应用在app开通的过程中获取company_id和company_token
  • 员工回调地址:用作员工oauth授权,主要应用在获取员工open_id和access_token
  • 事件通知地址:(1)资料更新通知回调地址,可以参考 事件通知。(2)用户配置单点登录跳转地址,可以参考 单点登陆

什么是企业开通回调?您的内部系统,对于企业QQ来说,就是一款App,所以要调用开放平台API,必须先在企业QQ上开通代表您内部系统的App。您申请AppID成功后,就会在企业账户中心的“应用管理”界面看到您的App,但是此时还无法开通成功。因为,开通某款App,本质上就是将您企业QQ的鉴权信息,交给那个App,所以,开通App的过程,就是递交鉴权信息的过程。您首先需要开发好接受鉴权信息的逻辑,才能实现开通。企业开通回调,就是鉴权信息传递的开始,我们有文档 参考oauth授权代码描述这个过程,供您参考实现。(详细的后台代码可以参考: 范例代码

企业开通回调,在表现形式上,是一个URL网址,代表了您服务器与企业QQ开放平台服务器通信的业务逻辑的部署网址。您可以在企业账户中心右上角的开发者模式中(需要企业管理员或者系统管理员权限),通过设置“应用管理页开通回调”来自行设置。

怎样调试开通流程?设置好开通回调后,您可以开始调试开通流程了,进入企业账户中心,应用管理页面,点击您App右侧的开关,点击过程中,您登记的回调会收到开放平台的调用,后续根据文档操作,即可完成开通过程。

在回调开通过程中,请您注意,回调地址必须是公网上可以访问到的服务器的网址,可以填写IP地址,但是不能是私有的网段。目前,开通流程还不支持本地调试和内网调试,如果您的业务系统必须内网调试和本地调试,请耐心等待,在支持内网和本地调试后,我们会第一时间通知您。

如何实现单点登录?企业QQ开放平台,支持两种单点登录方案。第一,在企业QQ主面板添加您业务系统的图标,点击后,跳转进入您的业务系统;第二,在您的业务系统页面,增加“使用企业QQ登录”按钮;

在企业QQ主面板增加图标的功能说明,可以参考这里。图标设计规范,可以参考这里。目前,请您将图标作为附件发送给,并在在邮件正文中,说明要添加的位置和跳转的目标网址,我们会在2个工作日内为您配置完毕。

在您业务系统页面上,提供“使用企业QQ登录”按钮,本质上也是实现OAuth授权的过程,通过实现使用员工帐号进行OAuth授权,即可实现员工帐号使用企业QQ登录系统。 如何调用消息发送API?调用消息发送API,是比较简易的,但是是建立在步骤2和步骤3完成的基础之上的,我们为您提供了API调用的范例代码,供您参考,从这里可以下载。

第三方应用如何调用企业QQ的API

企业QQ开放平台提供了丰富的API供开发者调用,但是API的调用需要企业QQ用户以企业为单位进行授权,授权使用OAuth2.0协议。授权完成后,App可以获取到企业的授权令牌和唯一标识,作为调用API的鉴权依据。

应用上线

应用开发完毕后,企业QQ会评估应用的质量,并最终开放应用开通入口到企业账户中心的“应用管理”页面。

use/guide.txt · 最后更改: 2016/04/22 17:05 (外部编辑)