go-data-bridge-client/README.md

49 lines
794 B
Markdown
Raw Permalink Normal View History

2019-07-09 22:02:15 +00:00
# go-data-bridge-client
Go client for accessing Data Bridge
2019-07-10 15:19:10 +00:00
2019-07-10 21:25:25 +00:00
https://data-bridge-docs.flipsidecrypto.com/#section/Introduction
2019-07-10 15:19:10 +00:00
## Usage
### Initialization
```
2019-09-16 17:34:53 +00:00
config := Config{APIKey: "api-key", TopicSlug: "my-topic-slug"}
2019-07-10 15:19:10 +00:00
client, err := NewClient(config)
```
2019-09-16 17:34:53 +00:00
### Get Registered Consumers
```
consumers, err := client.GetRegisteredConsumers()
```
### Get Available Consumers
```
consumers, err := client.GetAvailableConsumers()
```
### Register Consumer
```
consumer, err := client.RegisterConsumer()
```
2019-07-10 15:19:10 +00:00
### Get Next Record
```
2019-09-16 17:34:53 +00:00
record, err := client.GetNextRecord(consumerID)
2019-07-10 15:19:10 +00:00
```
### Mark Record Completed
```
err := client.CompleteRecord(record)
```
### Mark Record Failed
```
err := client.FailRecord(record)
```
2019-09-30 17:23:03 +00:00
### Publish New Record
```
err := client.PublishRecord(data)
```
2019-07-10 15:19:10 +00:00