POST /v1/rules
Add a rule. A pattern that already has a rule is reported, not changed.
Auth. Send the token in the X-Ledger-Token header.
Request body
application/json: object
| Field | Type | Required | Description |
|---|---|---|---|
pattern | string | required | Matched against the normalized merchant text, case-insensitively |
category | string | required | Must be on the category list |
priority | integer | optional | Lower is tried first |
Responses
| Status | Meaning | Body |
|---|---|---|
201 | Added | RuleCreated |
200 | The pattern already had a rule | RuleCreated |
400 | Request rejected | Error |
429 | Too many requests from this client address. Wait the number of seconds in Retry-After, then try again. | Error |
Example response
{
"id": 0,
"pattern": "string",
"category": "string",
"created": true
}
Code samples
Set KEY to your own token first.
curl
curl \
-X POST \
-H X-Ledger-Token:$KEY \
-H "Content-Type: application/json" \
-d '{"pattern": "string", "category": "string", "priority": 1}' \
"https://api.sasek.org/ledger/v1/rules"
JavaScript
const res = await fetch("https://api.sasek.org/ledger/v1/rules", {
method: "POST",
headers: { "X-Ledger-Token": KEY, "Content-Type": "application/json" },
body: JSON.stringify({
"pattern": "string",
"category": "string",
"priority": 1
}),
});
const data = await res.json();
Python
import json
import os
import urllib.request
payload = {'pattern': 'string', 'category': 'string', 'priority': 1}
request = urllib.request.Request(
"https://api.sasek.org/ledger/v1/rules",
method="POST",
headers={
"X-Ledger-Token": os.environ["KEY"],
"Content-Type": "application/json",
},
data=json.dumps(payload).encode(),
)
with urllib.request.urlopen(request) as response:
print(json.load(response))