kuaizhan

README

快站淘客开放接口API

快速使用

appKey := "your app key"
appSecret := "your app secret"
// 创建client
client := kuaizhan.NewClient(appKey, appSecret, nil)
// 获取站点信息
siteID := "1234567"
siteInfo, err := client.TbkGetSiteInfo(siteID, "")
if err != nil {
  panic(err)
}
// 查看结果
fmt.Printf("%+v\n", *siteInfo)

应用的申请参见官方文档：官方文档

支持快站所有接口

• TbkDomain 根据站点获取站点域名
• TbkSiteTraffic 根据域名获取站点的流量信息
• TbkChangeDomain 给指定站点修改域名
• TbkChangeDomainHttpsForward 开启/关闭域名Https跳转
• TbkGenKzShortUrl 生成快站短链接
• TbkGenKzShortUrl 第三方短链接生成
• TbkRevertShortURL 快码短链还原长链
• TbkModifyPageJs 更新页面js
• TbkPublishPage 发布页面
• TbkCheckDomainBan 检测域名是否被封禁
• TbkGenPromoteLink 生成淘口令推广链接
• TbkGetSiteIds 获取站点ID列表
• TbkGetPageIds 获取页面ID列表
• TbkGetPageName 获取页面列表
• TbkCreateSitePage 新建极速版站点页面
• TbkDeleteSitePage 新建极速版站点页面
• TbkCreateSite 创建快站站点
• TbkPublishSite 发布站点
• TbkUpdateSiteSetting 修改站点基本信息
• TbkGetSiteInfo 获取站点基本信息
• TbkGetSiteBansCount 获取站点当月被封禁的次数

Documentation

Index

• type Client
  • func NewClient(appKey, appSecret string, client *http.Client) *Client
  • func (c *Client) AgentChangeDomain(siteID, domain string) error
  • func (c *Client) Get(api string, values url.Values) (json.RawMessage, error)
  • func (c *Client) PostForm(api string, values url.Values) (json.RawMessage, error)
  • func (c *Client) Println(v ...interface{})
  • func (c *Client) SetDebugMode(isDebugging bool)
  • func (c *Client) TbkChangeDomain(siteID, domain string, forceHttps bool) error
  • func (c *Client) TbkChangeDomainHttpsForward(siteID, domain string, forceHttps bool) error
  • func (c *Client) TbkCheckDomainBan(domain string) (bool, error)
  • func (c *Client) TbkCreateSite(name, domain, siteType string) (*Site, error)
  • func (c *Client) TbkCreateSitePage(siteID, template string) (uint, error)
  • func (c *Client) TbkDeleteSitePage(pageId string) error
  • func (c *Client) TbkDomain(siteID string) (string, error)
  • func (c *Client) TbkGenKzShortURL(longURL string) (string, error)
  • func (c *Client) TbkGenPromoteLink(siteID, code, imageURL string) (string, error)
  • func (c *Client) TbkGenShortURL(longURL, urlType string) (string, error)
  • func (c *Client) TbkGetPageIds(siteID string) ([]uint, error)
  • func (c *Client) TbkGetPageName(siteID string) ([]*Page, error)
  • func (c *Client) TbkGetSiteBansCount(siteID string) (uint, error)
  • func (c *Client) TbkGetSiteIds() ([]uint, error)
  • func (c *Client) TbkGetSiteInfo(siteID, siteDomain string) (*Site, error)
  • func (c *Client) TbkModifyPageJs(siteID, pageID, content string, isEncrypted bool) error
  • func (c *Client) TbkPublishPage(siteID, pageID string) (string, error)
  • func (c *Client) TbkPublishSite(siteID string) (string, error)
  • func (c *Client) TbkRevertShortURL(shortURL string) (*RevertedShortURLInfo, error)
  • func (c *Client) TbkSitePvUvBySiteId(siteID, fromDate, toDate string) (*SiteTraffic, error)
  • func (c *Client) TbkSiteTraffic(domain string) (*SiteTraffic, error)
  • func (c *Client) TbkUpdateSiteSetting(siteID, siteName string) error
• type Page
• type Response
  • func (res *Response) Error() error
• type RevertedShortURLInfo
• type Site
• type SiteTraffic

Types

type Client

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

Client client

func NewClient

func NewClient(appKey, appSecret string, client *http.Client) *Client

NewClient 创建client

func (*Client) AgentChangeDomain

func (c *Client) AgentChangeDomain(siteID, domain string) error

AgentChangeDomain 修改客户域名

func (*Client) Get

func (c *Client) Get(api string, values url.Values) (json.RawMessage, error)

func (*Client) PostForm

func (c *Client) PostForm(api string, values url.Values) (json.RawMessage, error)

func (*Client) Println

func (c *Client) Println(v ...interface{})

func (*Client) SetDebugMode

func (c *Client) SetDebugMode(isDebugging bool)

func (*Client) TbkChangeDomain

func (c *Client) TbkChangeDomain(siteID, domain string, forceHttps bool) error

TbkChangeDomain 给指定站点修改域名, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/imqwx3

func (*Client) TbkChangeDomainHttpsForward

func (c *Client) TbkChangeDomainHttpsForward(siteID, domain string, forceHttps bool) error

TbkChangeDomainHttpsForward 开启/关闭域名Https跳转, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/mlvv6r

func (*Client) TbkCheckDomainBan

func (c *Client) TbkCheckDomainBan(domain string) (bool, error)

TbkCheckDomainBan 检测域名是否被封禁, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/bbn7u7

func (*Client) TbkCreateSite

func (c *Client) TbkCreateSite(name, domain, siteType string) (*Site, error)

TbkCreateSite 创建快站站点, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/fv1x9b

func (*Client) TbkCreateSitePage

func (c *Client) TbkCreateSitePage(siteID, template string) (uint, error)

TbkCreateSitePage 新建极速版站点页面, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/hexyr9

func (*Client) TbkDeleteSitePage

func (c *Client) TbkDeleteSitePage(pageId string) error

TbkDeleteSitePage 新建极速版站点页面, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/dyi82m

func (*Client) TbkDomain

func (c *Client) TbkDomain(siteID string) (string, error)

TbkDomain 根据站点获取站点域名, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/edk1gx

func (*Client) TbkGenKzShortURL

func (c *Client) TbkGenKzShortURL(longURL string) (string, error)

TbkGenKzShortUrl 生成快站短链接, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/naqeg6

func (*Client) TbkGenPromoteLink

func (c *Client) TbkGenPromoteLink(siteID, code, imageURL string) (string, error)

TbkGenPromoteLink 生成淘口令推广链接, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/fk2vtr

func (*Client) TbkGenShortURL

func (c *Client) TbkGenShortURL(longURL, urlType string) (string, error)

TbkGenKzShortUrl 第三方短链接生成, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/qeepyp

func (*Client) TbkGetPageIds

func (c *Client) TbkGetPageIds(siteID string) ([]uint, error)

TbkGetPageIds 获取页面ID列表, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/bkm43g

func (*Client) TbkGetPageName

func (c *Client) TbkGetPageName(siteID string) ([]*Page, error)

TbkGetPageName 获取所有站点页面名称, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/mehpsf

func (*Client) TbkGetSiteBansCount

func (c *Client) TbkGetSiteBansCount(siteID string) (uint, error)

TbkGetSiteBansCount 获取站点当月被封禁的次数, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/yigagy

func (*Client) TbkGetSiteIds

func (c *Client) TbkGetSiteIds() ([]uint, error)

TbkGetSiteIds 获取站点ID列表, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/gvltmw

func (*Client) TbkGetSiteInfo

func (c *Client) TbkGetSiteInfo(siteID, siteDomain string) (*Site, error)

TbkGetSiteInfo 获取站点基本信息, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/acgiwn

func (*Client) TbkModifyPageJs

func (c *Client) TbkModifyPageJs(siteID, pageID, content string, isEncrypted bool) error

TbkModifyPageJs 更新页面js, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/kahcrz

func (*Client) TbkPublishPage

func (c *Client) TbkPublishPage(siteID, pageID string) (string, error)

TbkPublishPage 发布页面, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/tbrdea

func (*Client) TbkPublishSite

func (c *Client) TbkPublishSite(siteID string) (string, error)

TbkPublishSite 发布站点, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/max5xw

func (*Client) TbkRevertShortURL

func (c *Client) TbkRevertShortURL(shortURL string) (*RevertedShortURLInfo, error)

TbkRevertShortURL 快码短链还原长链, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/gywhwq

func (*Client) TbkSitePvUvBySiteId

func (c *Client) TbkSitePvUvBySiteId(siteID, fromDate, toDate string) (*SiteTraffic, error)

TbkSitePvUvBySiteId 根据时间获取站点的流量, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/mphtng

func (*Client) TbkSiteTraffic

func (c *Client) TbkSiteTraffic(domain string) (*SiteTraffic, error)

TbkSiteTraffic 根据域名获取站点的流量信息, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/riha7l

func (*Client) TbkUpdateSiteSetting

func (c *Client) TbkUpdateSiteSetting(siteID, siteName string) error

TbkUpdateSiteSetting 修改站点基本信息, 详细查看 https://www.yuque.com/kuaizhan_help/ndcqmp/motq6t

type Page

type Page struct {
	PageID uint   `json:"pageId"`
	Title  string `json:"title"`
}

type Response

type Response struct {
	Code int             `json:"code"`
	Msg  string          `json:"msg"`
	Data json.RawMessage `json:"data"`
}

Response 公共返回结构体

func (*Response) Error

func (res *Response) Error() error

Error 转换错误为error对象

type RevertedShortURLInfo

type RevertedShortURLInfo struct {
	IsKzLink   bool   `json:"isKzLink"`
	OriginLink string `json:"originLink"`
}

type Site

type Site struct {
	ID                   string `json:"siteId"`
	PageID               string `json:"pageId"`
	Domain               string `json:"siteDomain"`
	Status               string `json:"siteStatus"`
	PackageName          string `json:"packageName"`
	PackageRemainingDays uint   `json:"packageRemainingDays"`
}

type SiteTraffic

type SiteTraffic struct {
	SiteID  string `json:"siteId"`
	PvCount string `json:"pvCount"`
	UvCount string `json:"uvCount"`
}