Linking - Transaction Link
Note: Multiple API Applications can "link" to the same transaction.
We've made it easier for you to keep your application in sync with Kindful by storing two important data points. The first, is the sync version on our transaction model. This increments every time a transaction is changed.
The second is the sync version indicating which version of a transaction your application "knows about". When the two sync versions are not the same, this means your application is "out of sync".
When the API transactions/query is queried for "changed" (out of sync) records, it will respond with any transactions linked to your application that have changed. To maintain the sync, you will then need to update your side with the updated transaction information and then call the link command to indicate or "link" that your application "knows about" the latest version.
Transaction Link Post Request
Make a POST
request to https://app-sandbox.kindful.com/api/v1/transactions/link
with the following in the body:
{
"action_type": "create",
"data": [
{"id": "1", "external_id": "ext_12345", "sync_version": "1", "updated_at": "2015-10-13 18:56:12 UTC" },
{"id": "2", "external_id": "ext_12346", "sync_version": "2", "updated_at": "2015-10-13 18:56:12 UTC" }
],
"data_type": "json"
}
Body Params
BODY PARAMS | |
---|---|
action_type string |
|
data array |
an array of elements with an id for kindful identifier and an external_id for the remote id. no more than 100 per post are allowed. use data_url if more is needed |
data_url string |
|
data_type string |
|
compression string |
|
encrypted (coming soon) string |
Linking Jobs are performed in background.
They are also queued along side normal Import Requests.