Skip to content

SDKs and tools

No SDK is published. The API is plain HTTP and JSON, with examples in the languages you already use.

Nasfam Business publishes no SDK, and none is announced. You need nothing more than an HTTP client.

Examples in your language

Every code panel on these pages is generated in the same set of languages and clients, and your choice holds on every page:

  • Node.js and TypeScript: Axios, Fetch and Undici.
  • Python: Requests and HTTPX.
  • PHP: cURL and Guzzle.
  • cURL from a terminal.

Generate a client

openapi.json is an OpenAPI 3.1 document of the whole contract. Import it into an API client, or generate a client from it. A generated client must ignore response fields, enum values and event types it does not know.

For TypeScript, npx openapi-typescript writes the contract's types into one file you call with any HTTP client: give it the address of openapi.json and an output path such as nasfam-api.d.ts. No SDK is published, so the file is yours to regenerate when the contract changes.

Request collection

The request collection holds every operation of the contract, against the sandbox host, in Postman's format, which Bruno and Insomnia import too. It is generated from openapi.json with each build.

  • Set NASFAM_SANDBOX_KEY to a sandbox key, as a secret. The collection holds no key.
  • Every request that changes your balance sends {{idempotencyKey}}, a new UUID each time. To retry the same request, pin it to the value you sent.
  • Each body is the example these pages show for that operation.

Working with an assistant

Every page has a Markdown twin, and llms.txt and skill.md are written for a coding assistant. They need no setup.

An MCP server is planned: a read-only server for these pages is built and tested, but it has no public address, so there is nothing to connect to.