dingding

README

钉钉登录集成

实现登录第三方网站

• 获取AuthCode
• 获取用户token
• 获取用户通讯录个人信息

Documentation

Index

• type Config
  • func NewDefaultDingDingConfig() *Config
• type DingDing
  • func NewDingDingClient(conf *Config) *DingDing
  • func (d *DingDing) GetUserInfo(ctx context.Context) (*User, error)
  • func (d *DingDing) Login(ctx context.Context, code string) error
• type DingDingAccessToken
  • func NewDingDingAccessToken() *DingDingAccessToken
• type GetUserTokenRequest
• type User
  • func NewUser() *User
  • func (u *User) Username() string

Types

type Config

type Config struct {
	// 开启钉钉认证
	Enabled bool `json:"enabled"`
	// 钉钉应用凭证, Oauth2.0时 也叫client_id
	ClientId string `json:"client_id" env:"DINGDING_CLIENT_ID"`
	// 钉钉应用凭证, Oauth2.0时 也叫client_secret
	ClientSecret string `json:"client_secret" env:"DINGDING_CLIENT_SECRET"`
	// Oauth2.0时, 应用服务地址页面
	RedirectUri string `json:"redirect_uri" env:"DINGDING_REDIRECT_URI"`
}

func NewDefaultDingDingConfig

func NewDefaultDingDingConfig() *Config

type DingDing

type DingDing struct {
	*Config
	// contains filtered or unexported fields
}

需要跟钉钉交互: 官方sdk： 直接根据API文档，封装直接的sdk (选择自己封装)

func NewDingDingClient

func NewDingDingClient(conf *Config) *DingDing

func (*DingDing) GetUserInfo

func (d *DingDing) GetUserInfo(ctx context.Context) (*User, error)

查询用户身份 https://open.dingtalk.com/document/orgapp-server/dingtalk-retrieve-user-information?spm=ding_open_doc.document.0.0.5cf7722fu9sqAm#doc-api-dingtalk-GetUser

func (*DingDing) Login

func (d *DingDing) Login(ctx context.Context, code string) error

获取用户Token https://open.dingtalk.com/document/orgapp-server/obtain-user-token?spm=ding_open_doc.document.0.0.5cf7722fu9sqAm#doc-api-dingtalk-GetUserToken

type DingDingAccessToken

type DingDingAccessToken struct {
	// 生成的accessToken
	AccessToken string `json:"accessToken"`
	// 生成的refresh_token。可以使用此刷新token，定期的获取用户的accessToken
	RefreshToken string `json:"refreshToken"`
	// 超时时间，单位秒。
	ExpiresIn int64 `json:"expireIn"`
	// 所选企业corpId。
	CorpId string `json:"corpId"`
	// access_token 颁发时间 <额外记录信息, 用于判断Token是否过期>
	IssueAt int64 `json:"issue_at"`
}

{
	"accessToken" : "abcd",
	"refreshToken" : "abcd",
	"expireIn" : 7200,
	"corpId" : "corpxxxx"
  }

func NewDingDingAccessToken

func NewDingDingAccessToken() *DingDingAccessToken

type GetUserTokenRequest

type GetUserTokenRequest struct {
	ClientId     string `json:"clientId"`
	ClientSecret string `json:"clientSecret"`
	Code         string `json:"code"`
	RefreshToken string `json:"refreshToken"`
	GrantType    string `json:"grantType"`
}

type User

type User struct {
	// 用户的钉钉昵称
	Nick string `json:"nick"`
	// 头像URL
	AvatarUrl string `json:"avatarUrl"`
	// 用户的手机号 如果要获取用户手机号，需要在开发者后台申请个人手机号信息权限
	Mobile string `json:"mobile"`
	// 用户的openId
	OpenId string `json:"openId"`
	// 用户的unionId
	UnionId string `json:"unionId"`
	// 用户的个人邮箱
	Email string `json:"email"`
	// 手机号对应的国家号
	StateCode string `json:"手机号对应的国家号"`
}

{
	"nick" : "zhangsan",
	"avatarUrl" : "https://xxx",
	"mobile" : "150xxxx9144",
	"openId" : "123",
	"unionId" : "z21HjQliSzpw0Yxxxx",
	"email" : "zhangsan@alibaba-inc.com",
	"stateCode" : "86"
  }

func NewUser

func NewUser() *User

func (*User) Username

func (u *User) Username() string