acquiringsdk

README

Worldline Acquiring Go SDK

Introduction

The Go SDK helps you to communicate with the Worldline Acquiring API. Its primary features are:

• convenient go wrapper around the API calls and responses
  • marshalls Go request structs to HTTP requests
  • unmarshalls HTTP responses to Go response structs or Go exceptions
• handling of all the details concerning authentication
• handling of required metadata

See the Worldline Acquiring Documentation for more information on how to use the SDK.

Requirements

Go version 1.20 or higher is required. No additional packages are required.

Examples

This repository also contains some example code. This code is contained in the examples folder.

Installation

Source

To install the latest version of this repository, run the following command from a terminal:

go get github.com/Worldline-Acquiring/acquiring-sdk-go

Release

Go 1.11 added module support and with that support for versions in go get. This means that, if your project uses modules, you can add @version to the go get command to get a specific version. For example, go get github.com/Worldline-Acquiring/acquiring-sdk-go@2.9.0 will download version 2.9.0 of the SDK. See the releases page for an overview of available releases.

If your project does not use modules yet, you will need to use the instructions above to install from source. Note that new major versions may introduce breaking changes. We therefore recommend using modules in your project. See Migrating to Go Modules for more information.

Running tests

There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required. First, some environment variables need to be set:

• acquiring.api.oauth2.clientId for the OAUth2 client id to use.
• acquiring.api.clientSecret for the OAuth2 client secret to use.
• acquiring.api.merchantId for your merchant ID.
• acquiring.api.proxyUrl for the URL to the proxy to use (optional). If set, it should be in the form scheme://[userinfo@]host[:port]. Examples: http://proxy.example.org, http://user:pass@proxy.example.org, http://proxy.example.org:3128.

The following commands can now be executed from the root directory of the SDK folder to execute the tests:

• Unit tests:

  go test ./...
  

• Both unit and integration tests:

  go test -tags=integration  ./...
  

Documentation

Index

• func CreateCommunicatorFromConfiguration(conf *configuration.CommunicatorConfiguration) (*communicator.Communicator, error)
• func CreateCommunicatorWithDefaultMarshaller(apiEndpoint *url.URL, connection communicator.Connection, ...) (*communicator.Communicator, error)
• func CreateOAuth2Configuration(clientID, clientSecret, tokenURI, integrator string) (*configuration.CommunicatorConfiguration, error)
• func FormatDate(date time.Time) string
• func FormatDateTime(dateTime time.Time) string
• func NewBool(value bool) *bool
• func NewCallContext() *communicator.CallContext
• func NewFloat64(value float64) *float64
• func NewInt32(value int32) *int32
• func NewInt64(value int64) *int64
• func NewString(value string) *string
• func ParseDate(date string) (time.Time, error)
• func ParseDateTime(dateTime string) (time.Time, error)
• type Client
  • func CreateClientFromCommunicator(communicator *communicator.Communicator) (*Client, error)
  • func CreateClientFromConfiguration(config *configuration.CommunicatorConfiguration) (*Client, error)
  • func CreateClientWithDefaultMarshaller(apiEndpoint *url.URL, connection communicator.Connection, ...) (*Client, error)
  • func NewClient(comm *communicator.Communicator) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) DisableLogging()
  • func (c *Client) EnableLogging(communicatorLogger logging.CommunicatorLogger)
  • func (c *Client) SetBodyObfuscator(bodyObfuscator obfuscation.BodyObfuscator)
  • func (c *Client) SetHeaderObfuscator(headerObfuscator obfuscation.HeaderObfuscator)
  • func (c *Client) V1() *apiv1.Client
• type CommunicatorBuilder
  • func CreateCommunicatorBuilderFromConfiguration(config *configuration.CommunicatorConfiguration) (*CommunicatorBuilder, error)
  • func NewCommunicatorBuilder() *CommunicatorBuilder
  • func (c *CommunicatorBuilder) Build() (*communicator.Communicator, error)
  • func (c *CommunicatorBuilder) WithAPIEndpoint(endpoint *url.URL) *CommunicatorBuilder
  • func (c *CommunicatorBuilder) WithAuthenticator(auth authentication.Authenticator) *CommunicatorBuilder
  • func (c *CommunicatorBuilder) WithConnection(connection communicator.Connection) *CommunicatorBuilder
  • func (c *CommunicatorBuilder) WithMarshaller(marshaller json.Marshaller) *CommunicatorBuilder
  • func (c *CommunicatorBuilder) WithMetadataProvider(provider *communicator.MetadataProvider) *CommunicatorBuilder

Functions

func CreateCommunicatorFromConfiguration

func CreateCommunicatorFromConfiguration(conf *configuration.CommunicatorConfiguration) (*communicator.Communicator, error)

CreateCommunicatorFromConfiguration creates a Communicator with the given CommunicatorConfiguration

func CreateCommunicatorWithDefaultMarshaller

func CreateCommunicatorWithDefaultMarshaller(apiEndpoint *url.URL, connection communicator.Connection, authenticator authentication.Authenticator, metadataProvider *communicator.MetadataProvider) (*communicator.Communicator, error)

CreateCommunicatorWithDefaultMarshaller creates a Communicator with the given components and a default marshaller

func CreateOAuth2Configuration

func CreateOAuth2Configuration(clientID, clientSecret, tokenURI, integrator string) (*configuration.CommunicatorConfiguration, error)

CreateOAuth2Configuration creates a CommunicatorConfiguration with default OAuth2 settings and the given clientID, clientSecret and tokenURI

func FormatDate

func FormatDate(date time.Time) string

FormatDate formats a time.Time instance into an ISO date string

func FormatDateTime

func FormatDateTime(dateTime time.Time) string

FormatDateTime formats a time.Time instance into an ISO date-time string

func NewBool

func NewBool(value bool) *bool

NewBool returns a pointer for a boolean value. This can be used to assign literals to domain or query parameter objects

func NewCallContext

func NewCallContext() *communicator.CallContext

NewCallContext creates an empty CallContext

func NewFloat64

func NewFloat64(value float64) *float64

NewFloat64 returns a pointer for a float64 value. This can be used to assign literals to domain or query parameter objects

func NewInt32

func NewInt32(value int32) *int32

NewInt32 returns a pointer for an int32 value. This can be used to assign literals to domain or query parameter objects

func NewInt64

func NewInt64(value int64) *int64

NewInt64 returns a pointer for an int64 value. This can be used to assign literals to domain or query parameter objects

func NewString

func NewString(value string) *string

NewString returns a pointer for a string value. This can be used to assign literals to domain or query parameter objects

func ParseDate

func ParseDate(date string) (time.Time, error)

ParseDate parses a string in ISO format into a time.Time instance

func ParseDateTime

func ParseDateTime(dateTime string) (time.Time, error)

ParseDateTime parses a string in ISO into a time.Time instance

Types

type Client

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

Client is the Worldline Acquiring platform client. Thread-safe.

func CreateClientFromCommunicator

func CreateClientFromCommunicator(communicator *communicator.Communicator) (*Client, error)

CreateClientFromCommunicator creates a Client with the given Communicator

func CreateClientFromConfiguration

func CreateClientFromConfiguration(config *configuration.CommunicatorConfiguration) (*Client, error)

CreateClientFromConfiguration creates a Client with the given CommunicatorConfiguration

func CreateClientWithDefaultMarshaller

func CreateClientWithDefaultMarshaller(apiEndpoint *url.URL, connection communicator.Connection, authenticator authentication.Authenticator, metadataProvider *communicator.MetadataProvider) (*Client, error)

CreateClientWithDefaultMarshaller creates a Client with the given components and a default marshaller

func NewClient

func NewClient(comm *communicator.Communicator) (*Client, error)

NewClient creates a new Client with the given communicator

func (*Client) Close

func (c *Client) Close() error

Close calls the internal closer of the communicator

func (*Client) DisableLogging

func (c *Client) DisableLogging()

DisableLogging turns off logging.

func (*Client) EnableLogging

func (c *Client) EnableLogging(communicatorLogger logging.CommunicatorLogger)

EnableLogging turns on logging using the given communicator logger.

func (*Client) SetBodyObfuscator

func (c *Client) SetBodyObfuscator(bodyObfuscator obfuscation.BodyObfuscator)

SetBodyObfuscator sets the body obfuscator to use.

func (*Client) SetHeaderObfuscator

func (c *Client) SetHeaderObfuscator(headerObfuscator obfuscation.HeaderObfuscator)

SetHeaderObfuscator sets the header obfuscator to use.

func (*Client) V1

func (c *Client) V1() *apiv1.Client

V1 represents API v1

type CommunicatorBuilder

type CommunicatorBuilder struct {
	APIEndpoint      *url.URL
	Connection       communicator.Connection
	MetadataProvider *communicator.MetadataProvider
	Authenticator    authentication.Authenticator
	Marshaller       json.Marshaller
}

CommunicatorBuilder is the builder for Communicator objects

func CreateCommunicatorBuilderFromConfiguration

func CreateCommunicatorBuilderFromConfiguration(config *configuration.CommunicatorConfiguration) (*CommunicatorBuilder, error)

CreateCommunicatorBuilderFromConfiguration creates a CommunicatorBuilder with the given CommunicatorConfiguration

func NewCommunicatorBuilder

func NewCommunicatorBuilder() *CommunicatorBuilder

NewCommunicatorBuilder creates a CommunicatorBuilder object

func (*CommunicatorBuilder) Build

func (c *CommunicatorBuilder) Build() (*communicator.Communicator, error)

Build creates a Communicator object based on the builder parameters

func (*CommunicatorBuilder) WithAPIEndpoint

func (c *CommunicatorBuilder) WithAPIEndpoint(endpoint *url.URL) *CommunicatorBuilder

WithAPIEndpoint sets the Worldline Acquiring platform API endpoint to be used by the Communicator

func (*CommunicatorBuilder) WithAuthenticator

func (c *CommunicatorBuilder) WithAuthenticator(auth authentication.Authenticator) *CommunicatorBuilder

WithAuthenticator sets the Authenticator to be used by the Communicator

func (*CommunicatorBuilder) WithConnection

func (c *CommunicatorBuilder) WithConnection(connection communicator.Connection) *CommunicatorBuilder

WithConnection sets the Connection to be used by the Communicator

func (*CommunicatorBuilder) WithMarshaller

func (c *CommunicatorBuilder) WithMarshaller(marshaller json.Marshaller) *CommunicatorBuilder

WithMarshaller sets the Marshaller to be used by the Communicator

func (*CommunicatorBuilder) WithMetadataProvider

func (c *CommunicatorBuilder) WithMetadataProvider(provider *communicator.MetadataProvider) *CommunicatorBuilder

WithMetadataProvider sets the MetadataProvider to be used by the Communicator