api

Documentation

Index

• type Client
  • func NewClient(apiUrl string) *Client
  • func (c *Client) Get(route string, queryValues map[string]string) (*RawResponse, error)
  • func (c *Client) Post(route string, queryValues map[string]string, body []byte) (*RawResponse, error)
• type Handler
  • func NewHandler(apiUrl string) *Handler
  • func (h *Handler) RetrieveCertificate(companyChainID string, uuid string) (*entityApi.TransactionWrapper, error)
  • func (h *Handler) RetrieveSecrets(companyChainID string, certificateUuid string) (*entityApi.TransactionWrappers, error)
  • func (h *Handler) SendCertificate(transaction *entityApi.Transaction) (*entityApi.TransactionStatus, error)
  • func (h *Handler) SendSecret(transaction *entityApi.Transaction, companyChainID string, ...) (*entityApi.TransactionStatus, error)
  • func (h *Handler) SendTransaction(route string, transaction []byte) (*entityApi.TransactionStatus, error)
• type RawResponse

Types

type Client

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

Client is a fasthttp.Client wrapper to dialog with a JSON API.

func NewClient

func NewClient(apiUrl string) *Client

Client constructor.

func (*Client) Get

func (c *Client) Get(route string, queryValues map[string]string) (*RawResponse, error)

Get wraps the doRequest method to do a GET HTTP request.

func (*Client) Post

func (c *Client) Post(route string, queryValues map[string]string, body []byte) (*RawResponse, error)

Post wraps the doRequest method to do a POST HTTP request.

type Handler

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

Handler provides helper methods to send and retrieve transactions without directly interacting with the HTTP Client.

func NewHandler

func NewHandler(apiUrl string) *Handler

Handler constructor.

func (*Handler) RetrieveCertificate

func (h *Handler) RetrieveCertificate(companyChainID string, uuid string) (*entityApi.TransactionWrapper, error)

RetrieveCertificate fetches the API and returns a transaction wrapper or an error.

func (*Handler) RetrieveSecrets

func (h *Handler) RetrieveSecrets(
	companyChainID string,
	certificateUuid string,
) (*entityApi.TransactionWrappers, error)

RetrieveSecrets fetches the API and returns a transaction wrapper list or an error.

func (*Handler) SendCertificate

func (h *Handler) SendCertificate(transaction *entityApi.Transaction) (*entityApi.TransactionStatus, error)

SendCertificate accepts a transaction and sends it to the appropriate certificate API route.

func (*Handler) SendSecret

func (h *Handler) SendSecret(
	transaction *entityApi.Transaction,
	companyChainID string,
	certificateUuid string,
) (*entityApi.TransactionStatus, error)

SendSecret accepts a transaction and sends it to the appropriate secret API route.

func (*Handler) SendTransaction

func (h *Handler) SendTransaction(
	route string,
	transaction []byte,
) (*entityApi.TransactionStatus, error)

SendTransaction tries to send a transaction to the API and returns a transaction status or an error.

type RawResponse

type RawResponse struct {
	StatusCode int
	Body       []byte
}

Response is a fasthttp.Response wrapper.