Categorygithub.com/emaopay/emaopay-sdk-go
repositorypackage
0.0.0-20240830123656-3326e7e18a26
Repository: https://github.com/emaopay/emaopay-sdk-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# 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

ClassMethodHTTP requestDescription
DefaultApiCheckServiceStatusGet /api/monitors/messages检查服务状态
DefaultApiCreateMerchantPost /api/merchants创建商户
DefaultApiCreateMonitorPost /api/monitors创建监控
DefaultApiCreateNewMerchantPost /api/merchants/new创建新商户
DefaultApiCreateNewMonitorPost /api/monitors/new创建新监控
DefaultApiCreateOrderPost /api/orders创建订单
DefaultApiCreateQrCodePost /api/qrcodes创建二维码
DefaultApiDeleteMonitorByIdDelete /api/monitors/{id}删除监控
DefaultApiDeleteQrCodeByIdDelete /api/qrcodes删除二维码
DefaultApiFinishedOrderByIdPost /api/orders/finish/{id}手动完成订单
DefaultApiGetMerchantByIdGet /api/merchants/{id}获取商户信息
DefaultApiGetMerchantListByUserIdGet /api/merchants获取商户列表
DefaultApiGetMonitorByIdGet /api/monitors/{id}获取监控
DefaultApiGetMonitorListByMerchantIdGet /api/monitors获取监控列表
DefaultApiGetMonitorMessageListByMerchantIdGet /api/merchants/:merchantId/messages获取监控消息列表(商户ID)
DefaultApiGetMonitorMessageListByMonitorIdGet /api/monitors/:monitorId/messages获取监控消息列表(商户监控)
DefaultApiGetOrderByIdGet /api/orders/{id}获取订单信息
DefaultApiGetOrderListByUserIdGet /api/orders/user获取订单列表
DefaultApiGetPagedOrderListGet /api/orders获取订单列表
DefaultApiGetPaymentProvidersGet /api/orders/payment-providers获取支付方式
DefaultApiGetQrCodePagedListByMonitorIdGet /api/qrcodes获取二维码列表
DefaultApiGetQrCodeUploadCreditsGet /api/qrcodes/upload-credits获取二维码上传凭证
DefaultApiGetUserInfoGet /api/user/info获取用户信息
DefaultApiLoginPost /api/user/login登录
DefaultApiNotifyOrderByIdPost /api/orders/notify/{id}通知订单回调
DefaultApiPushMessagePost /api/monitors/messages推送消息
DefaultApiRefreshMonitorApiTokenPut /api/monitors/{monitorId}/refresh-api-token刷新ApiToken
DefaultApiRegisterPost /api/user/register注册
DefaultApiUpdateMerchantPut /api/merchants/{id}更新商户
DefaultApiUpdateMonitorPut /api/monitors/{id}更新监控

Documentation For Models

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

Author

[email protected]