vip_gosdk

README

vip-sdk

唯品会开放平台Golang版本SDK

单元测试

鉴于安全原因, 不便暴露 appKey/secret 等信息. 所以在测试命令后提供了如下参数.

go test -v -args -appKey xxx -secret xxx -userNumber xxx

快速开始

import (
	"fmt"
	"github.com/lcr2000/vip-gosdk"
)

var Client *vip_gosdk.Client

func init()  {
	Client = vip_gosdk.NewClient("appKey", "secret", "userNumber")
}

func GetAddress() {
	res, err := Client.SelectAddress("")
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(res)
}

Documentation

Index

• Constants
• Variables
• func Hmac(key, data string) string
• type ApplyPaymentResp
• type ApplyPaymentResponse
  • func (resp *ApplyPaymentResponse) String() string
• type BaseResp
• type Client
  • func NewClient(appKey, secret, userNumber string) *Client
  • func (client *Client) ApplyPayment(orderSn, clientIp string) (resp *ApplyPaymentResponse, err error)
  • func (client *Client) Do(req Request, params map[string]interface{}, res Response) (err error)
  • func (client *Client) OrderCancel(orderSn string) (resp *OrderCancelResponse, err error)
  • func (client *Client) OrderCreate(req *OrderCreateReq) (resp *OrderCreateResponse, err error)
  • func (client *Client) OrderInfoList(orderSnList string) (resp *OrderInfoListResponse, err error)
  • func (client *Client) SelectAddress(areaCode string) (resp *SelectAddressResponse, err error)
• type OrderCancelResp
• type OrderCancelResponse
  • func (resp *OrderCancelResponse) String() string
• type OrderCreateReq
• type OrderCreateResp
• type OrderCreateResponse
  • func (resp *OrderCreateResponse) String() string
• type OrderInfoListResp
• type OrderInfoListResponse
  • func (resp *OrderInfoListResponse) String() string
• type Request
• type Response
• type SelectAddressRequest
  • func (a SelectAddressRequest) ApiMethod() string
  • func (a SelectAddressRequest) RequestMethod() string
• type SelectAddressResp
• type SelectAddressResponse
  • func (resp *SelectAddressResponse) String() string
• type VipApiEncrypt

Constants

const (
	Format  = "JSON"
	Service = "com.vip.wpc.ospservice.vop.WpcVopOspService"
	Domain  = "https://gw.vipapis.com"
	Version = "1.0.0"
)

base

const (
	ApplyPaymentMethod     = "applyPayment"
	OrderCreateMethod      = "orderCreate"
	OrderCancelMethod      = "orderCancel"
	SelectAddressMethod    = "selectAddress"
	GetOrderInfoListMethod = "getOrderInfoList"
)

method

const (
	DefaultPage     = 1
	DefaultPageSize = 20
)

Default pagination parameters

Variables

var (
	// ErrInvalidOrderCreate invalid order create params
	ErrInvalidOrderCreate = errors.New("invalid order create params")
	// ErrOrderSnRequired order number required
	ErrOrderSnRequired = errors.New("order number required")
	// ErrOrderSnAndIpRequired order number or ip is empty
	ErrOrderSnOrIpEmpty = errors.New("order number or ip is empty")
)

Functions

func Hmac

func Hmac(key, data string) string

Generate hmac-md 5 encryption.

Types

type ApplyPaymentResp

type ApplyPaymentResp struct {
	BaseResp
	Result struct {
		ApplySuccess bool   `json:"applySuccess"`
		FailReason   string `json:"failReason"`
	} `json:"result"`
}

申请代扣

type ApplyPaymentResponse

type ApplyPaymentResponse struct {
	ApplyPaymentResp
}

func (*ApplyPaymentResponse) String

func (resp *ApplyPaymentResponse) String() string

type BaseResp

type BaseResp struct {
	ReturnCode    string `json:"returnCode"`
	ReturnMessage string `json:"returnMessage"`
}

type Client

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

The client saves some private required fields. Before executing the request, a new Client must be created.

func NewClient

func NewClient(appKey, secret, userNumber string) *Client

NewClient returns a new Client. appKey, secret, userNumber can not be empty.

func (*Client) ApplyPayment

func (client *Client) ApplyPayment(orderSn, clientIp string) (resp *ApplyPaymentResponse, err error)

申请代扣 http://vop.vip.com/home;jsessionid=74C224D59EAC53838899EF34F2ED9BA7#/api/method/detail/com.vip.wpc.ospservice.vop.WpcVopOspService-1.0.0/applyPayment

func (*Client) Do

func (client *Client) Do(req Request, params map[string]interface{}, res Response) (err error)

General request.

func (*Client) OrderCancel

func (client *Client) OrderCancel(orderSn string) (resp *OrderCancelResponse, err error)

取消订单 http://vop.vip.com/home;jsessionid=74C224D59EAC53838899EF34F2ED9BA7#/api/method/detail/com.vip.wpc.ospservice.vop.WpcVopOspService-1.0.0/orderCancel

func (*Client) OrderCreate

func (client *Client) OrderCreate(req *OrderCreateReq) (resp *OrderCreateResponse, err error)

创建订单 http://vop.vip.com/home;jsessionid=74C224D59EAC53838899EF34F2ED9BA7#/api/method/detail/com.vip.wpc.ospservice.vop.WpcVopOspService-1.0.0/orderCreate

func (*Client) OrderInfoList

func (client *Client) OrderInfoList(orderSnList string) (resp *OrderInfoListResponse, err error)

订单状态信息 http://vop.vip.com/home;jsessionid=74C224D59EAC53838899EF34F2ED9BA7#/api/method/detail/com.vip.wpc.ospservice.vop.WpcVopOspService-1.0.0/getOrderInfoList

func (*Client) SelectAddress

func (client *Client) SelectAddress(areaCode string) (resp *SelectAddressResponse, err error)

查询地址库 http://vop.vip.com/home;jsessionid=74C224D59EAC53838899EF34F2ED9BA7#/api/method/detail/com.vip.wpc.ospservice.vop.WpcVopOspService-1.0.0/selectAddress

type OrderCancelResp

type OrderCancelResp struct {
	BaseResp
	Result struct {
		Code int    `json:"code"`
		Msg  string `json:"msg"`
	} `json:"result"`
}

取消订单

type OrderCancelResponse

type OrderCancelResponse struct {
	OrderCancelResp
}

func (*OrderCancelResponse) String

func (resp *OrderCancelResponse) String() string

type OrderCreateReq

type OrderCreateReq struct {
	AreaId    string
	SizeInfo  string
	Address   string
	Consignee string
	Mobile    string
	ClientIp  string
	TraceId   string
}

type OrderCreateResp

type OrderCreateResp struct {
	BaseResp
	Result struct {
		Orders []struct {
			OrderSn string `json:"orderSn"`
		} `json:"orders"`
	} `json:"result"`
}

创建订单

type OrderCreateResponse

type OrderCreateResponse struct {
	OrderCreateResp
}

func (*OrderCreateResponse) String

func (resp *OrderCreateResponse) String() string

type OrderInfoListResp

type OrderInfoListResp struct {
	BaseResp
	Result []struct {
		ChildOrderSnList []struct {
			RealPayTotal string `json:"RealPayTotal"`
			ShippingFee  string `json:"ShippingFee"`
			Goods        []struct {
				GoodFullID string `json:"goodFullId"`
				Price      string `json:"price"`
				SizeID     string `json:"sizeId"`
				SizeNum    int64  `json:"sizeNum"`
			} `json:"goods"`
			OrderSn       string `json:"orderSn"`
			RefundStatus  int64  `json:"refundStatus"`
			StatusCode    int64  `json:"statusCode"`
			StatusName    string `json:"statusName"`
			TransportNo   string `json:"transportNo"`
			TransportName string `json:"transportName"`
		} `json:"childOrderSnList"`
		ParentOrderSn string `json:"parentOrderSn"`
	} `json:"result"`
}

订单状态信息

type OrderInfoListResponse

type OrderInfoListResponse struct {
	OrderInfoListResp
}

func (*OrderInfoListResponse) String

func (resp *OrderInfoListResponse) String() string

type Request

type Request interface {
	ApiMethod() string
	RequestMethod() string
}

The Request describes a request's method and request request type

type Response

type Response interface{}

The Request describes a request's return information

type SelectAddressRequest

type SelectAddressRequest struct{}

func (SelectAddressRequest) ApiMethod

func (a SelectAddressRequest) ApiMethod() string

func (SelectAddressRequest) RequestMethod

func (a SelectAddressRequest) RequestMethod() string

type SelectAddressResp

type SelectAddressResp struct {
	BaseResp
	Result struct {
		ChildList []struct {
			AreaCode string `json:"areaCode"`
			AreaName string `json:"areaName"`
		} `json:"childList"`
		Info struct {
			AreaCode string `json:"areaCode"`
			AreaName string `json:"areaName"`
		} `json:"info"`
	} `json:"result"`
}

查询地址库

type SelectAddressResponse

type SelectAddressResponse struct {
	SelectAddressResp
}

func (*SelectAddressResponse) String

func (resp *SelectAddressResponse) String() string

type VipApiEncrypt

type VipApiEncrypt struct {
	AppKey    string `json:"appKey"`
	Format    string `json:"format"`
	Method    string `json:"method"`
	Service   string `json:"service"`
	Timestamp string `json:"timestamp"`
	Version   string `json:"version"`
}

Signature encryption string.