Class ZipEnvironment

Represents a particular environment for the Zip API (i.e test for NZ merchants, production for AU merchants etc).

Inheritance

Object

ZipEnvironment

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.Zip.InStore

Assembly: Yort.Zip.InStore.dll

Syntax

public class ZipEnvironment

Remarks

You can construct instances of this class in order to support future environments that may come online before the library is updated with support, but for convenience use the pre-built instances provided by the static properties on this class, i.e Test provides the test environment for the NZ region.

Constructors

ZipEnvironment(String, Uri, Uri)

Full contructor.

Declaration

public ZipEnvironment(string audience, Uri tokenEndpoint, Uri baseUrl)

Parameters

Type	Name	Description
String	audience	The 'audience' or 'API Identifier' required when requesting an auth token for this environment.
Uri	tokenEndpoint	The full URL used to request an auth token to access the API for this endpoint.
Uri	baseUrl	The root url (including common sub-path) to the API for this environment.

Properties

Audience

Returns the 'audience'/'API Identifier' associated with this environment.

Declaration

public string Audience { get; }

Property Value

Type	Description
String

BaseUrl

Returns base url (including common root path) for this environment.

Declaration

public Uri BaseUrl { get; }

Property Value

Type	Description
Uri

TokenEndpoint

Returns the full url used to retrieve an auth token for this environment.

Declaration

public Uri TokenEndpoint { get; }

Property Value

Type	Description
Uri

See Also

Production

Test