Content Chef Go SDK

Content Chef Go SDK.

Requirements

In order to use this SDK, you will need

• An active ContentChef account
• Go

Installation

If you are using go modules you can just import the SDK in your codebase.

import "github.com/ContentChef/contentchef-go/contentchef"'

API

ContentChef client

First you have to initialize the ContentChef client.

"github.com/ContentChef/contentchef-go/contentchef"

myOptions := &contentchef.Options{
    BaseUrl: "https://api.contentchef.io/",
    SpaceID: "yourContentChefSpaceID",
}

cf, _ := contentchef.New(opt)

Here are the fields of the configuration that can be passed to the Constructor

// contentchef.ClientOptions
type ClientOptions struct {
	// The base URL of your Content Chef instance REQUIRED
	BaseURL string
	// Your Content Chef SpaceID REQUIRED
	SpaceID string
	// The HTTP client to communicate with the ContentChef API
	// If you don't want to use the default HTTP client you can set a custom one
	Client *http.Client
	// TargetDate is used to retrieve contents in the preview channel in a specific dare different from the current date
	TargetDate time.Time
}

Channels

A channel is a collector of contents.

The SDK returns two channels: OnlineChannel and a PreviewChannel.

With OnlineChannel you can retrieve contents which are in live state and which are actually visible, while with the PreviewChannel you can retrieve contents which are in in both stage and live state and even contents that are not visible in the current date

Both OnlineChannel and PreviewChannel have two methods which are GetContent and Search that accepts the same parameters. eg.

func (s *OnlineChannel) Content(ctx context.Context, config *ContentOptions) (*Response, error) {
    // ...
}
func (s *OnlineChannel) Search(ctx context.Context, config *SearchOptions) (*PaginatedResponse, error) {
    // ...
}

So, if you want to achieve polymorphic behavior you can define an interface like this

type Channel interface {
	Content(ctx context.Context, config *ContentOptions) (*Response, error)
	Search(ctx context.Context, config *SearchOptions) (*PaginatedResponse, error)
}

You can use the Content methods to collect a specific content by it's own PublicId, to retrieve, for example to retrieve a single post from your blog, a single image from a gallery or a set of articles from your featured articles list. Otherwise you can use the Search methods to find content with multiple matching criteria, like content definition name, publishing dates and more.

Example:

First you have to get an OnlineChannel or PreviewChannel instance, Then you cause you instance for query for content.

"github.com/ContentChef/contentchef-go/contentchef"
// ...

myOptions := &contentchef.ClientOptions{
    BaseURL: "https://api.contentchef.io/",
    SpaceID: "yourContentChefSpaceID",
}
cf, _ := contentchef.New(opt)

// An OnlineChannel will query only published contents in live state in the current date
chOnline := cf.GetOnlineChannel("yourChannelName", "yourChannelAPIKey")

// A PreviewChannel will query only the published content with a staging state
chPreview := cf.GetPreviewChannel("yourChannelName", "yourChannelAPIKey", "staging")

conf := &contentchef.GetContentOptions{
    PublicID: "yourContentPublicID",
}

// will retrieve from the channel a single content
// GetContent accepts two parameters.
// A context object (if you are unsure about it use Context.TODO())
// The GetContent configuration object.
myContent, err := ch.GetContent(context.TODO(), conf)

// Here is the GetContent configuration object.
// ContentOptions specifies the parameters to the Channel's Content method.
type ContentOptions struct {
	LegacyMetadata bool `url:"legacyMetadata,omitempty"`
	// The publicId of the content you want to retrieve
	PublicID string `url:"publicId"`
}

searchConf := &contentchef.SearchOptions{
	Take:    10,
	[]contentchef.SortingField{{FieldName: "publicId", Ascending: false}},
}

// will retrieve from the channel website a single content
// Search accepts two parameters.
// A context object (if you are unsure about it use Context.TODO())
// The Search configuration object
myPaginatedResponse, err := ch.Search(context.TODO(), conf)

//Here is the Search configuration object
// Search Options specifies the parameters to the Channel's and OnlineChannel's Search method.
type SearchOptions struct {
	// The offset you want to have in the search result.
	Skip int `url:"skip"`
	// The number of contents you want to retrieve
	Take int `url:"take"`
	// A slice containing the publicIds of the content you want to retrieve
	PublicID []string `url:"publicId,omitempty"`
	// A slice containing the definitions of the content you want to retrieve
	ContentDefinition []string `url:"contentDefinition,omitempty"`
	Repositories      []string `url:"repositories,omitempty"`
	LegacyMetadata    bool     `url:"legacyMetadata,omitempty"`
	// A slice containing the tags of the content you want to retrieve
	Tags []string `url:"tags,omitempty"`
	// Properties filters you want to apply
	PropFilters PropFilters `url:"propFilters,omitempty"`
	// How you want to sort your content
	Sorting Sorting `url:"sorting,omitempty"`
}