Explore everything

DEVELOPER DOCUMENTATION

Inspect a contract before building the integration.

A runnable offline example for checking the operations declared by the supplied source.

Runs locally against the downloaded reference

This Python standard-library example reads JSON and prints the source declarations. It makes no network requests, authenticates to no account and does not execute commerce actions.

1. Download the two files.

Download inspect_contract.py ↗

Download openapi.json ↗

2. Inspect an actual route.

python inspect_contract.py openapi.json /pricing/price-lists

Run from the directory containing both files, using Python 3. Choose a path exactly as it appears in the supplied reference, without adding the server base path.

3. Read the result.

Contract version: 0.1.0
GET /pricing/price-lists
  Summary: List price lists
  Responses: 200
  Request body: not declared
POST /pricing/price-lists
  Summary: Create price list
  Responses: 201
  Request body: not declared

This output was checked against the packaged source reference. It confirms route declarations; it does not validate deployed permissions, response bodies or live commercial behaviour.

Handle the missing-contract case.

A route absent from the downloaded reference produces a clear error. Generic responses or sparse payload declarations should be treated as missing implementation information, not filled with guessed fields.

Explore Agora

Press Esc to close · Every result opens a dedicated page.

The Agora story

Founder recording with animated product sequences. View the pitch summary and further walkthroughs ↗

Supplied Agora workspace