credential

Documentation

Index

• Constants
• type AccessToken
• type AccessTokenHandle
  • func NewDefaultAccessToken(clientKey, clientSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle
• type ClientToken
• type DefaultAccessToken
  • func (ak *DefaultAccessToken) GetAccessToken(openID string) (accessToken string, err error)
  • func (ak *DefaultAccessToken) GetClientToken() (clientToken *ClientToken, err error)
  • func (ak *DefaultAccessToken) RefreshAccessToken(refreshToken string) (accessToken *AccessToken, err error)
  • func (ak *DefaultAccessToken) RenewRefreshToken(refreshToken string) (refreshTokenData *RefreshToken, err error)
  • func (ak *DefaultAccessToken) SetAccessToken(accessToken *AccessToken) (err error)
• type DefaultJsTicket
  • func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err error)
• type JsTicketHandle
  • func NewDefaultJsTicket(appID string, cacheKeyPrefix string, cache cache.Cache) JsTicketHandle
• type RefreshToken
• type Ticket
  • func GetTicketFromServer(accessToken string) (ticket Ticket, err error)

Constants

const (

	// CacheKeyPrefix 抖音open cache key前缀
	CacheKeyPrefix = "douyin_open"
)

Types

type AccessToken

type AccessToken struct {
	util.CommonError

	AccessToken    string `json:"access_token"`
	ExpiresIn      int64  `json:"expires_in"`
	RefreshToken   string `json:"refresh_token"`
	RefreshTokenIn int64  `json:"refresh_expires_in"`
	OpenID         string `json:"open_id"`
	Scope          string `json:"scope"`
}

AccessToken struct

type AccessTokenHandle

type AccessTokenHandle interface {
	GetAccessToken(openID string) (accessToken string, err error)
	SetAccessToken(accessToken *AccessToken) (err error)
	GetClientToken() (clientToken *ClientToken, err error)
}

AccessTokenHandle AccessToken 接口

func NewDefaultAccessToken

func NewDefaultAccessToken(clientKey, clientSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle

NewDefaultAccessToken new DefaultAccessToken

type ClientToken

type ClientToken struct {
	util.CommonError

	AccessToken string `json:"access_token"`
	ExpiresIn   int64  `json:"expires_in"`
}

ClientToken struct.

type DefaultAccessToken

type DefaultAccessToken struct {
	ClientKey    string
	ClientSecret string
	// contains filtered or unexported fields
}

DefaultAccessToken 默认AccessToken 获取

func (*DefaultAccessToken) GetAccessToken

func (ak *DefaultAccessToken) GetAccessToken(openID string) (accessToken string, err error)

GetAccessToken 获取access_token,先从cache中获取，没有则从服务端获取

func (*DefaultAccessToken) GetClientToken

func (ak *DefaultAccessToken) GetClientToken() (clientToken *ClientToken, err error)

GetClientToken 该接口用于获取接口调用的凭证client_access_token，主要用于调用不需要用户授权就可以调用的接口.

func (*DefaultAccessToken) RefreshAccessToken

func (ak *DefaultAccessToken) RefreshAccessToken(refreshToken string) (accessToken *AccessToken, err error)

RefreshAccessToken 刷新AccessToken. 当access_token过期（过期时间15天）后，可以通过该接口使用refresh_token（过期时间30天）进行刷新

func (*DefaultAccessToken) RenewRefreshToken

func (ak *DefaultAccessToken) RenewRefreshToken(refreshToken string) (refreshTokenData *RefreshToken, err error)

RenewRefreshToken 刷新refresh_token. 前提： client_key需要具备renew_refresh_token这个权限 接口说明： 可以通过旧的refresh_token获取新的refresh_token,调用后旧refresh_token会失效，新refresh_token有30天有效期。最多只能获取5次新的refresh_token，5次过后需要用户重新授权。

func (*DefaultAccessToken) SetAccessToken

func (ak *DefaultAccessToken) SetAccessToken(accessToken *AccessToken) (err error)

SetAccessToken 设置access_token

type DefaultJsTicket

type DefaultJsTicket struct {
	// contains filtered or unexported fields
}

DefaultJsTicket 默认获取js ticket方法

func (*DefaultJsTicket) GetTicket

func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err error)

GetTicket 获取jsapi_ticket

type JsTicketHandle

type JsTicketHandle interface {
	//GetTicket 获取ticket
	GetTicket(accessToken string) (ticket string, err error)
}

JsTicketHandle js ticket获取

func NewDefaultJsTicket

func NewDefaultJsTicket(appID string, cacheKeyPrefix string, cache cache.Cache) JsTicketHandle

NewDefaultJsTicket new

type RefreshToken

type RefreshToken struct {
	util.CommonError

	ExpiresIn    int64  `json:"expires_in"`
	RefreshToken string `json:"refresh_token"`
}

RefreshToken .

type Ticket

type Ticket struct {
	util.CommonError

	Ticket    string `json:"ticket"`
	ExpiresIn int64  `json:"expires_in"`
}

Ticket 请求jsapi_tikcet返回结果

func GetTicketFromServer

func GetTicketFromServer(accessToken string) (ticket Ticket, err error)

GetTicketFromServer 从服务器中获取ticket