About this guide

17.1 What’s in it

innbucks-merchant-api-integration/
├── README.md                ← this guide (also published as the documentation site)
├── innbucks-skills/
│   ├── innbucks-integration/ ← the Claude skill (install this folder; see section 16)
│   ├── README.md            ← skill layout: what is generated and what is hand-written
│   └── VERIFICATION.md      ← what was run to check the skill, and the results
├── assets/                  ← logos used by this README (InnBucks, 67even)
├── docs/                    ← GitHub Pages site (just-the-docs), generated from this README
│   ├── _config.yml, _includes/, _sass/   ← theme, SEO and structured-data setup
│   └── assets/              ← logos, InnBucks screenshots and brand images, Open Graph cards
├── tools/                   ← site generator, card generator, example tests and checks
├── .github/workflows/
│   ├── tests.yml            ← CI: builds the site and runs every check
│   └── release.yml          ← on a vX.Y.Z tag: GitHub Release with notes and the skill zip
├── CHANGELOG.md
├── LICENSE                  ← MIT
└── NOTICE                   ← trademark and non-affiliation notice

The pages of the documentation site are generated from this README by tools/build_docs.py, so the two never drift. Edit the README, then run:

python3 tools/build_docs.py         # regenerate docs/
python3 tools/build_og_images.py    # regenerate social cards (needs Playwright + Chromium)
python3 tools/check_links.py        # every link and anchor resolves
python3 tools/check_docs_site.py    # Jekyll config and front matter are sound
python3 tools/build_skill.py        # regenerate the skill's references and templates
python3 tools/check_skill.py        # the skill's frontmatter, size and file references
python3 tools/test_examples.py      # the code examples and the skill CLI work against a mock InnBucks server

To release, add a ## X.Y.Z — YYYY-MM-DD entry to CHANGELOG.md, then tag and push:

git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z

.github/workflows/release.yml then publishes the GitHub Release, with the changelog entry as its notes (tools/release_notes.py) and innbucks-integration.zip attached.

17.2 Sources

Written from the material InnBucks gives integrating merchants: the InnBucks Merchant API Document v1.2.1, the Merchant Integration Guidelines and Process, the Integration UAT Sign Off form, and the InnBucks logo and colour guides (v2.00, 2024), as reviewed on 22 September

Those documents are not reproduced here: InnBucks provides them to merchants under its terms and NDA. If InnBucks’ documents change, they win. Please open an issue.

17.3 Licence and disclaimer

The guide and tools are MIT licensed. This is an independent, community-maintained project. It is not affiliated with, endorsed by, or supported by InnBucks MicroBank Limited. “InnBucks”, the InnBucks logo, its colours and related marks belong to their owner and are used here only to identify the API being documented and to show how InnBucks asks merchants to present it. See NOTICE.

Written and maintained by John Mugabe under 67even.

This page is generated from section 17 of the README in README.md. Spotted something wrong? Open an issue.