Welcome to go-cerberus documentation!

go-cerberus is a Go client library for communicating with the cerberus (by a11n.io) backend, whether you’re using the cloud hosted backend, or have installed in on-premises in your own datacenter.

Check out the Usage section for further information, including getting started on the project.

Note

This project is under active development.

Contents

Usage

Import

To use go-cerberus, import it in your go project:

import (
    cerberus "github.com/a11n-io/go-cerberus"
)

Creating the client

To create the client you will use the cerberus.NewClient(baseUrl, apiKey, apiSecret string) function:

cerberusClient := cerberus.NewClient(”https://api_cerberus.a11n.io:80”, “YOUR_CERBERUS_API_KEY”, “YOUR_CERBERUS_API_SECRET”)

The baseUrl parameter could be the hosted cloud, or your own installation url. The apiKey and apiSecret parameters are generated on the cerberus dashboard for the app you’re developing against.