API

Agent skill

Teach your coding agent the Supliful API before it writes your integration.

The Supliful API skill packages what an agent needs to build against this API without guessing: the endpoints, the order lifecycle, webhook verification, every error type, and where to read the OpenAPI spec this site is built from.

Installation

Install it with the skills CLI, from the root of your project:

npx skills add supliful/agent-skills

The CLI asks which of your coding agents to install it for. The skill is in the open Agent Skills format, and its source is Supliful/agent-skills on GitHub. Run the command again to update it.

What the skill covers

  • SKILL.md — when the agent should use the skill, and the integration steps in order.
  • references/ — endpoints, webhooks, errors and merchant setup. The skill reads the OpenAPI spec live from GET /v1/openapi.json, the same spec as the API Reference, so it never drifts from the API.
  • scripts/sign-webhook.sh — signs a test delivery and sends it to your local receiver, so you can check signature verification before a real event exists.

On this page