README
Harmony Connect
Connect is your fast lane to the blockchain. Add blockchain capabilities to any software without needing to wrestle with currencies, wallets, or blockchain nodes. Instead, you get easy read and write access to the Factom blockchain. Connect will also track your data’s path to immutability and will notify you along the way.
Getting Credentials
There’s no need to get credentials to test the Harmony Connect API and create blockchain records and identities. However, if you plan to make heavier use of the API, we recomend registering for a free Sandbox Blockchain account.
Harmony Basics
As you navigate the Factom blockchain, there are a few things you’ll come across. Here are some of the most common ones.
For more detailed documentation, visit the Connect Developer Hub.
Entry
A Factom entry is the most basic unit on the Factom blockchain. Entries can be formatted in specific ways in order to broadcast messages or create proof for blockchain applications.
Schema
| Name | Type | Description |
|---|---|---|
| entry_hash | string | The unique identitfier of the entry. |
| chain | object | An object that contains the Chain Hash (ID) as well as a URL for the chain. |
| created_at | string | The time when this entry was created. Sent in [ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601). For example: YYYY-MM-DDThh:mm:ss.ssssssZ |
| external_ids | string array | Tags that can be used to identify your entry. You can search for records that contain a particular external_id using Connect. External IDs are returned in Base64. |
| content | string | This is the data that is stored by the entry. Content will be sent in Base64 format. |
| stage | string | The level of immutability that this entry has reached. |
| dblock | object | Represents the Directory Block that relates to this entry. This will be null if the chain is not at least at the factom immutability stage. |
| eblock | object | Represents the Entry Block that contains the entry. This will be null if the entry is not at least at the factom immutability stage. |
Chain
A chain is a collection of Factom entries, listed in the order of their creation time. Each entry in a chain is connected to the previous entries via a cryptographic hash. Like entries, chains can be customized in order to be used in specific blockchain applications. Every chain also has a unique Chain ID based on the parameters of the first entry.
Schema
| Name | Type | Description |
|---|---|---|
| chain_id | string | This is the unique identifier created for each chain. |
| content | string | This is the data that was stored in the first entry of this chain. |
| external_ids | string array | Tags that have been used to identify this entry. |
| stage | string | The immutability stage that this chain has reached. |
| entries | object | An API link to all of the entries in this chain. |
| eblock | object | Represents the Entry Block that contains the first entry of this chain. This will be null if the chain is not at least at the factom immutability stage. |
| dblock | object | Represents the Directory Block that relates to this chain. This will be null if the chain is not at least at the factom immutability stage. |
| created_at | string | The time at which this chain was created. Sent in [ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601). For example: YYYY-MM-DDThh:mm:ss.ssssssZ. This will be null if the chain is not at least at the factom immutability stage. |
Identity
A Factom Identity is a specific type of chain that represents a digital agent. This allows a person or a device to authenticate data that has been published to this or other blockchains. Like other chains, Identities are made up of entries. Each one indicates an action taken that updates the status of the Identity.
Schema
| Name | Type | Description |
|---|---|---|
| version | string | The Identity Chain’s schema version. This details the format of this digital identity. |
| stage | string | The immutability stage that this chain has reached. The identity can be considered in use once it reaches the factom stage. |
| created_height | integer | The block height at which this chain was written into the Factom blockchain. This is null if the chain has not reached the factom stage. |
| chain_id | string | The Chain ID for this identity chain. |
| name | string | A unique array of strings that are associated with this identity. |
| active_keys | object array | Contains the currently active public keys for this identity. |
| all_keys_href | string | An API link to retrieve the keys for this identity. |
More Information
For a full guide to using the Harmony Connect API as well as more information about the Factom blockchain and protocols, check out the Connect Developer Hub! You can also access our support channels as well as our community forum.
