Factom Harmony Connect - Go Client Library

This is an automatically generated Go client library for Factom Harmony Connect.

Connect is the fastest way to add blockchain capabilities to your app without cryptocurrencies, wallets, or network nodes. Create an account to get your free API key for the sandbox environment.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.19
• Package version: 1.0.7
• Build package: org.openapitools.codegen.languages.GoClientCodegen

For more information, please visit https://docs.harmony.factom.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./connectclient"

Documentation for API Endpoints

All URIs are relative to https://ephemeral.api.factom.com/v1

Class	Method	HTTP request	Description
ChainsApi	GetChainByID	Get /chains/{chain_id}	Get Chain Info
ChainsApi	GetChains	Get /chains	Get All Chains
ChainsApi	PostChain	Post /chains	Create a Chain
ChainsApi	PostChainSearch	Post /chains/search	Search Chains
EntriesApi	GetEntriesByChainID	Get /chains/{chain_id}/entries	Get Chain's Entries
EntriesApi	GetEntryByHash	Get /chains/{chain_id}/entries/{entry_hash}	Get Entry Info
EntriesApi	GetFirstEntry	Get /chains/{chain_id}/entries/first	Get Chain's First Entry
EntriesApi	GetLastEntry	Get /chains/{chain_id}/entries/last	Get Chain's Last Entry
EntriesApi	PostEntriesSearch	Post /chains/{chain_id}/entries/search	Search Chain's Entries
EntriesApi	PostEntryToChainID	Post /chains/{chain_id}/entries	Create an Entry
IdentitiesApi	GetIdChainbyId	Get /identities/{identity_chain_id}	Get Identity Chain Info
IdentitiesApi	GetKeybyEntryHash	Get /identities/{identity_chain_id}/keys/{key_string}	Get Key Info
IdentitiesApi	GetKeysbyIdChainId	Get /identities/{identity_chain_id}/keys	Get Identity Chain's Keys
IdentitiesApi	PostIdChain	Post /identities	Create Identity Chain
IdentitiesApi	PostKeytoIdChainId	Post /identities/{identity_chain_id}/keys	Replace Identity Key
InfoApi	GetApiInfo	Get /	API Info
ProofsApi	GetAnchorbySearch	Get /anchors/{object_id}	Get Object's Anchors
ProofsApi	GetReceiptsbyEntry	Get /receipts/{entry_hash}	Get Entry's Receipts
ProofsApi	GetSearch	Get /search	Search

Documentation For Models

• ABlockEntry
• ABlockEntryData
• ABlockEntryLink
• ABlockEntryList
• ABlockList
• ABlockLong
• ABlockLongDblock
• ABlockLongNext
• ABlockLongPrev
• ABlockShort
• ABlockShortDblock
• Address
• AddressLink
• AddressList
• AllInfo
• AllInfoLinks
• AnchorLong
• AnchorLongData
• BitcoinAnchor
• Chain
• ChainCreate
• ChainData
• ChainDataDblock
• ChainDataEblock
• ChainDataEntries
• ChainLink
• ChainList
• ChainListData
• ChainShort
• CommitLink
• CommitLong
• DBlockLink
• DBlockList
• DBlockLong
• DBlockLongAblock
• DBlockLongBtcAnchorEntry
• DBlockLongBtcAnchorEntryChain
• DBlockLongEblocks
• DBlockLongEcblock
• DBlockLongFblock
• DBlockLongNext
• DBlockLongPrev
• DBlockShort
• EBlockLink
• EBlockLinkChain
• EBlockList
• EBlockLong
• EBlockLongNext
• EBlockLongPrev
• EBlockShort
• EBlockShortChain
• EBlockShortDblock
• EcBlockEntryList
• EcBlockList
• EcBlockLong
• EcBlockLongDblock
• EcBlockShort
• Entry
• EntryCreate
• EntryData
• EntryDataDblock
• EntryDataEblock
• EntryList
• EntryListChain
• EntryListData
• EntrySearchResponse
• EntrySearchResponseData
• EntryShort
• ErrorMessage
• ErrorMessageErrors
• EthereumAnchor
• FBlockList
• FBlockLong
• FBlockLongNext
• FBlockLongPrev
• FBlockShort
• FactomAnchor
• IdentityChain
• IdentityCreate
• IdentityKey
• IdentityKeyData
• IdentityKeyReplace
• IdentityKeyShort
• IdentityKeyShortData
• InlineResponse200
• InlineResponse200Data
• KeyList
• MerkleNode
• ReceiptLong
• ReceiptLongData
• SearchBody
• SingleAnchor
• Transaction
• TransactionLink
• TransactionLinkShort
• TransactionList
• TransactionShort

Documentation For Authorization

You can retreive your Harmony Connect authentication details by creating an account at account.factom.com. The Base URL and API Keys can be found on the application details page.

BaseURL

Example

config := connect_client.NewConfiguration()
config.BasePath = "YOUR BASE PATH"
client := connect_client.NewAPIClient(config)

API Keys

Example

keys := connect_client.APIKey{
	AppId: "YOUR APP ID", 
	AppKey: "YOUR APP KEY",
}

auth := context.WithValue(context.Background(), connect_client.ContextAPIKey, keys)

Support

For more information, you can view the Connect documentation at https://docs.harmony.factom.com

For additional support, contact us at harmony-support@factom.com