Class Blue5Options

Connection settings for the Bluestone PIM Public API (PAPI).

Inheritance

object

Blue5Options

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Activout.Blue5

Assembly: Activout.Blue5.dll

Syntax

public sealed class Blue5Options

Properties

ApiKey

PAPI key, sent as the x-api-key header. Never logged or echoed.

Declaration

public required string ApiKey { get; init; }

Property Value

Type	Description
string

BaseAddress

Environment root, e.g. https://api.bluestonepim.com/ or https://api.test.bluestonepim.com/. Blue5 appends the v1/ PAPI path itself.

Declaration

public required Uri BaseAddress { get; init; }

Property Value

Type	Description
Uri

Context

Default PAPI context (language/publication), sent as the context header.

Declaration

public string Context { get; init; }

Property Value

Type	Description
string