api

Documentation

Index

• Constants
• func PrepareRequest(signer *crypto.Signer, data *bytes.Buffer, method string, url string, ...) (*http.Request, error)
• func PrepareResponse(signer *crypto.Signer, body []byte, req *http.Request, meta *Metadata) (*http.Response, error)
• func VerifyRequest(signer *crypto.Signer, req *http.Request) (bool, error)
• type ApiHeader
• type Metadata

Constants

const STANDARD_VERSION string = "1"

Functions

func PrepareRequest

func PrepareRequest(signer *crypto.Signer, data *bytes.Buffer, method string, url string, meta *Metadata) (*http.Request, error)

func PrepareResponse

func PrepareResponse(signer *crypto.Signer, body []byte, req *http.Request, meta *Metadata) (*http.Response, error)

func VerifyRequest

func VerifyRequest(signer *crypto.Signer, req *http.Request) (bool, error)

Types

type ApiHeader

type ApiHeader string

const (
	SIGNATURE_PUBKEY ApiHeader = "X-API-SIG-PUB"
	SIGNATURE        ApiHeader = "X-API-SIG"
	VERSION          ApiHeader = "X-API-VER"
	PROJECT          ApiHeader = "X-API-PROJ"
	STANDARD         ApiHeader = "X-API-STD"
)

type Metadata

type Metadata struct {
	Version   string
	ProjectID uint64
}

API Metadata