README.md in bckbn-1.0.0 vs README.md in bckbn-1.1.0
- old
+ new
@@ -7,10 +7,13 @@
```bash
gem install bckbn
```
## Configuration
+Local configuration will override global configuration where
+they conflict. Some config can only be set locally, like an
+`idempotency_key`.
### Global
```ruby
require "bckbn"
@@ -24,31 +27,38 @@
id: "12345",
report_group: "ABC Division"
})
```
-### Per Request
+### Local
```ruby
require "bckbn"
api_base = "..."
access_token = "..."
merchant_id = "..."
+idempotency_key = "..."
Bckbn::Transaction.capture(
{
litle_txn_id: "13254123434",
id: "12345",
report_group: "ABC Division"
},
{
- api_base:,
- access_token:,
- merchant_id:
+ api_base: api_base,
+ access_token: access_token,
+ merchant_id: merchant_id,
+ idempotency_key: idempotency_key
}
)
```
+
+### Idempotency
+An idempotency key can be added to allow retries without creating duplicate transactions.
+Successful POST requests will return a cached response. New requests can be issued
+by changing the request body or the idempotency key.
## Documentation
```
open doc/index.html