flareio

README

go-flareio

flareio is a light Flare API SDK that wraps around net/http.Client and automatically manages authentication.

It exposes methods that are similar to net/http.Client with the exception that they accept paths as parameters instead of full URLs.

Usage examples and use cases are documented in the Flare API documentation.

Contributing

• make test will run tests
• make format format will format the code
• make lint will run typechecking + linting

Basic Usage

package main

import (
	"fmt"
	"io"
	"os"

	"github.com/Flared/go-flareio"
)

func main() {
	client := flareio.NewApiClient(
		os.Getenv("FLARE_API_KEY"),
	)
	resp, err := client.Get(
		"/leaksdb/v2/sources",
	)
	if err != nil {
		fmt.Printf("failed to get sources: %s\n", err)
		os.Exit(1)
	}
	defer resp.Body.Close()
	if _, err := io.Copy(os.Stdout, resp.Body); err != nil {
		fmt.Printf("failed to print sources: %s\n", err)
		os.Exit(1)
	}
}

Documentation

Index

• type ApiClient
  • func NewApiClient(apiKey string, optionFns ...ApiClientOption) *ApiClient
  • func (client *ApiClient) GenerateToken() (string, error)
  • func (client *ApiClient) Get(path string) (*http.Response, error)
  • func (client *ApiClient) GetParams(path string, params *url.Values) (*http.Response, error)
  • func (client *ApiClient) Post(path, contentType string, body io.Reader) (*http.Response, error)
• type ApiClientOption
  • func WithTenantId(tenantId int) ApiClientOption

Types

type ApiClient

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

func NewApiClient

func NewApiClient(
	apiKey string,
	optionFns ...ApiClientOption,
) *ApiClient

func (*ApiClient) GenerateToken

func (client *ApiClient) GenerateToken() (string, error)

func (*ApiClient) Get

func (client *ApiClient) Get(path string) (*http.Response, error)

func (*ApiClient) GetParams

func (client *ApiClient) GetParams(path string, params *url.Values) (*http.Response, error)

func (*ApiClient) Post

func (client *ApiClient) Post(path, contentType string, body io.Reader) (*http.Response, error)

type ApiClientOption

type ApiClientOption func(*ApiClient)

func WithTenantId

func WithTenantId(tenantId int) ApiClientOption

WithTenantId allows configuring the tenant id.