api

package
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 27, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package classification Qredo Signing Agent V2

The Qredo Signing Agent service interacts with [Partner API](https://developers.qredo.com/partner-api/api/swagger/) to register a Signing Agent to automate approvals according to your custody policy. <br/> Authentication and encryption are required; set up your [API key and secret in the Qredo Web App](https://developers.qredo.com/signing-agent/v2-signing-agent/get-started/). <br/>

Version: 1.0.0 Contact: Qredo API Services<support@qredo.com> https://www.qredo.com Schemes: http, https Host: localhost:8007 BasePath: /api/v1 License: APACHE 2.0 https://www.apache.org/licenses/LICENSE-2.0 swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionResponse added in v1.0.1 

type ActionResponse struct {
	// The ID of the transaction.
	// example: eXAmplElvWbnPf1YaAc1XD85jJX
	ActionID string `json:"actionID"`

	// The status of the transaction
	// enum: approved,rejected
	Status string `json:"status"`
}

swagger:model ActionResponse

func NewApprovedActionResponse added in v1.0.1 

func NewApprovedActionResponse(action_id string) ActionResponse

func NewRejectedActionResponse added in v1.0.1 

func NewRejectedActionResponse(action_id string) ActionResponse

type AgentRegisterResponse added in v1.0.1 

type AgentRegisterResponse struct {
	// The ID of the agent.
	// example: exAMplePrDdcDDVU8idhuJGK2U1P4vmQcsp8wnED8pPR
	AgentID string `json:"agentID"`

	// The feed WebSocket URL.
	// example: http://localhost:8007/api/v1/client/feed
	FeedURL string `json:"feedURL"`
}

swagger:model AgentRegisterResponse

type ClientRegisterFinishRequest 

type ClientRegisterFinishRequest struct {
	ID           string `json:"id"`
	AccountCode  string `json:"accountCode"`
	ClientID     string `json:"clientID"`
	ClientSecret string `json:"clientSecret"`
	IDDocument   string `json:"idDoc"`
}

swagger:ignore

type ClientRegisterFinishResponse 

type ClientRegisterFinishResponse struct {
	FeedURL string `json:"feed_url"`
}

swagger:ignore

type ClientRegisterRequest 

type ClientRegisterRequest struct {
	// The name of the agent.
	// example: test-agent
	Name string `json:"name"`

	// The API key for the partner API.
	// example: eyJrZXkiOiJHM0Fo... (truncated)
	APIKey string `json:"APIKey"`

	// The Base64-encoded private key pem of which the public key has been registered in the Partner API.
	// example: LS0tLS1CRUdJTiBS... (truncated)
	Base64PrivateKey string `json:"base64PrivateKey"`
}

swagger:model ClientRegisterRequest

func (*ClientRegisterRequest) Validate 

func (r *ClientRegisterRequest) Validate() error

type ClientRegisterResponse 

type ClientRegisterResponse struct {
	BLSPublicKey string `json:"bls_public_key"`
	ECPublicKey  string `json:"ec_public_key"`
	RefID        string `json:"ref_id"`
}

swagger:ignore

type CoreClientServiceActionApproveRequest 

type CoreClientServiceActionApproveRequest struct {
	Signatures []string `json:"signatures"`
	ClientID   string   `json:"client_id,omitempty"`
	ActionID   string   `json:"action_id,omitempty"`
}

swagger:ignore

type CoreClientServiceActionMessagesResponse 

type CoreClientServiceActionMessagesResponse struct {
	Messages []string `json:"messages"`
}

swagger:ignore

type CoreClientServiceRegisterFinishRequest 

type CoreClientServiceRegisterFinishRequest struct {
	ClientID          string `json:"client_id,omitempty"`
	IDDocSignatureHex string `json:"idDocSignatureHex"`
}

swagger:ignore

type CoreClientServiceRegisterFinishResponse 

type CoreClientServiceRegisterFinishResponse struct {
	Feed string `json:"feed"`
}

swagger:ignore

type DOCClientFeedResponse 

type DOCClientFeedResponse struct {
	// The ID of the transaction.
	// example: eXAmplElvWbnPf1YaAc1XD85jJX
	ID string `json:"id"`

	// The ID of the agent.
	// example: exAMplePrDdcDDVU8idhuJGK2U1P4vmQcsp8wnED8pPR
	CoreClientID string `json:"coreClientID"`

	// The type of the transaction.
	// enum: ApproveWithdraw,ApproveTransfer
	// example: ApproveWithdraw
	Type string `json:"type"`

	// The status of the transaction.
	// enum: pending,expired,approved,rejected
	// example: pending
	Status string `json:"status"`

	// The time that the transaction was started, utc unix time.
	// example: 1670341423
	Timestamp int64 `json:"timestamp"`

	// The time that the transaction will expire, utc unix time.
	// example: 1676184187
	ExpireTime int64 `json:"expireTime"`
}

swagger:model ClientFeedResponse

type DOCClientRegisterRequest 

type DOCClientRegisterRequest struct {
	// in:body
	Body ClientRegisterRequest
}

swagger:parameters RegisterAgent

type DOCErrorResponse added in v1.0.1 

type DOCErrorResponse struct {
	// The result code of the request.
	// example: 404
	Code int

	// The result message of the request.
	// example: Not found
	Msg string
}

swagger:model ErrorResponse

type DOCGetClientResponse added in v1.0.1 

type DOCGetClientResponse struct {
	// in:body
	Body GetClientResponse
}

swagger:model GetClientResponse

type GetClientResponse added in v1.0.1 

type GetClientResponse struct {
	// The ID of the agent.
	// example: exAMplePrDdcDDVU8idhuJGK2U1P4vmQcsp8wnED8pPR
	AgentID string `json:"agentID"`

	// The name of the agent.
	// example: some-agent
	AgentName string `json:"agentName"`

	// The feed WebSocket URL.
	// example: http://localhost:8007/api/v1/client/feed
	FeedURL string `json:"feedURL"`
}

swagger:model GetClientResponse

type HealthCheckStatusResponse 

type HealthCheckStatusResponse struct {
	WebsocketStatus WebsocketStatus `json:"websocket"`
}

swagger:model StatusResponse

type QredoRegisterInitRequest 

type QredoRegisterInitRequest struct {
	Name         string `json:"name"`
	BLSPublicKey string `json:"blsPublicKey"`
	ECPublicKey  string `json:"ecPublicKey"`
}

swagger:ignore

func NewQredoRegisterInitRequest 

func NewQredoRegisterInitRequest(name, blsPublicKey, ecPublicKey string) *QredoRegisterInitRequest

type QredoRegisterInitResponse 

type QredoRegisterInitResponse struct {
	ID           string `json:"id"`
	ClientID     string `json:"clientID"`
	ClientSecret string `json:"clientSecret"`
	AccountCode  string `json:"accountCode"`
	IDDocument   string `json:"idDoc"`
	Timestamp    int64  `json:"timestamp"`
}

swagger:ignore

type SignRequest 

type SignRequest struct {
	MessageHashHex string `json:"message_hash_hex" validate:"required"`
}

swagger:ignore

type SignResponse 

type SignResponse struct {
	SignatureHex string `json:"signature_hex"`
	SignerID     string `json:"signer_id"`
}

swagger:ignore

type VerifyRequest 

type VerifyRequest struct {
	MessageHashHex string `json:"message_hash_hex" validate:"required"`
	SignatureHex   string `json:"signature_hex" validate:"required"`
	SignerID       string `json:"signer_id" validate:"required"`
}

swagger:ignore

type WebsocketStatus 

type WebsocketStatus struct {
	// The state of the WebSocket connection with the server.
	// enum: OPEN,CLOSED,CONNECTING
	// example: OPEN
	ReadyState string `json:"readyState"`

	// The server WebSocket URL.
	// example: wss://sandbox-api.qredo.network/api/v1/p/coreclient/feed,
	RemoteFeedUrl string `json:"remoteFeedURL"`

	// The local feed WebSocket URL.
	// example: ws://localhost:8007/api/v1/client/feed
	LocalFeedUrl string `json:"localFeedURL"`

	// The number of connected feed clients.
	// example: 2
	ConnectedClients uint32 `json:"connectedClients"`
}

swagger:model WebsocketStatus

func NewWebsocketStatus 

func NewWebsocketStatus(readyState, remoteFeedUrl, localFeedUrl string, connectedClients int) WebsocketStatus

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.