# Packages
# README
Go API client for emaopay
EmaoPay API.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0
- Package version: 1.7.3
- Generator version: 7.6.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://emaopay.com/support
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import emaopay "github.com/emaopay/emaopay-sdk-go"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value emaopay.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), emaopay.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value emaopay.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), emaopay.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using emaopay.ContextOperationServerIndices
and emaopay.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), emaopay.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), emaopay.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to http://emaopay.com
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | CheckServiceStatus | Get /api/monitors/messages | 检查服务状态 |
DefaultApi | CreateMerchant | Post /api/merchants | 创建商户 |
DefaultApi | CreateMonitor | Post /api/monitors | 创建监控 |
DefaultApi | CreateNewMerchant | Post /api/merchants/new | 创建新商户 |
DefaultApi | CreateNewMonitor | Post /api/monitors/new | 创建新监控 |
DefaultApi | CreateOrder | Post /api/orders | 创建订单 |
DefaultApi | CreateQrCode | Post /api/qrcodes | 创建二维码 |
DefaultApi | DeleteMonitorById | Delete /api/monitors/{id} | 删除监控 |
DefaultApi | DeleteQrCodeById | Delete /api/qrcodes | 删除二维码 |
DefaultApi | FinishedOrderById | Post /api/orders/finish/{id} | 手动完成订单 |
DefaultApi | GetMerchantById | Get /api/merchants/{id} | 获取商户信息 |
DefaultApi | GetMerchantListByUserId | Get /api/merchants | 获取商户列表 |
DefaultApi | GetMonitorById | Get /api/monitors/{id} | 获取监控 |
DefaultApi | GetMonitorListByMerchantId | Get /api/monitors | 获取监控列表 |
DefaultApi | GetMonitorMessageListByMerchantId | Get /api/merchants/:merchantId/messages | 获取监控消息列表(商户ID) |
DefaultApi | GetMonitorMessageListByMonitorId | Get /api/monitors/:monitorId/messages | 获取监控消息列表(商户监控) |
DefaultApi | GetOrderById | Get /api/orders/{id} | 获取订单信息 |
DefaultApi | GetOrderListByUserId | Get /api/orders/user | 获取订单列表 |
DefaultApi | GetPagedOrderList | Get /api/orders | 获取订单列表 |
DefaultApi | GetPaymentProviders | Get /api/orders/payment-providers | 获取支付方式 |
DefaultApi | GetQrCodePagedListByMonitorId | Get /api/qrcodes | 获取二维码列表 |
DefaultApi | GetQrCodeUploadCredits | Get /api/qrcodes/upload-credits | 获取二维码上传凭证 |
DefaultApi | GetUserInfo | Get /api/user/info | 获取用户信息 |
DefaultApi | Login | Post /api/user/login | 登录 |
DefaultApi | NotifyOrderById | Post /api/orders/notify/{id} | 通知订单回调 |
DefaultApi | PushMessage | Post /api/monitors/messages | 推送消息 |
DefaultApi | RefreshMonitorApiToken | Put /api/monitors/{monitorId}/refresh-api-token | 刷新ApiToken |
DefaultApi | Register | Post /api/user/register | 注册 |
DefaultApi | UpdateMerchant | Put /api/merchants/{id} | 更新商户 |
DefaultApi | UpdateMonitor | Put /api/monitors/{id} | 更新监控 |
Documentation For Models
- EmaopayCreateMerchantParams
- EmaopayCreateMonitorParams
- EmaopayCreateNewMonitorParams
- EmaopayCreateOrderParams
- EmaopayCreateQrCodeParams
- EmaopayCredentials
- EmaopayDeleteQrCodeParams
- EmaopayLoginParams
- EmaopayLoginResponse
- EmaopayMerchant
- EmaopayMonitor
- EmaopayMonitorMessage
- EmaopayMonitorMessageParams
- EmaopayOrder
- EmaopayPagedResponseEmaopayMonitorMessage
- EmaopayPagedResponseEmaopayOrder
- EmaopayPagedResponseEmaopayQrCode
- EmaopayQrCode
- EmaopayRegisterParams
- EmaopayUploadCredits
- EmaopayUser
Documentation For Authorization
Endpoints do not require authorization.
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime