Skip to content

joaotonaco/appmax-api-sdk

Repository files navigation

@appmax-api/sdk

Unofficial NodeJS SDK for consuming the Appmax API.

Installation

npm install @appmax-api/sdk
// or
yarn add @appmax-api/sdk
// or
pnpm add @appmax-api/sdk

Getting Started

import { AppmaxAPI } from "@appmax-api/sdk"
// const { AppmaxAPI } = require("@appmax-api/sdk")

const api = new AppmaxAPI("Access Token")

Features

  • Testing mode (use homolog.sandboxappmax url)

      new AppmaxAPI("Access Token", { testMode: true })
  • Create customers (/customer)

      api.customers.create()
  • Create orders (/order)

      api.orders.create()
  • Initiate payments (/payment/*)

      api.payments.create()
  • Tokenize cards (/tokenize/card)

      api.payments.tokenize()
  • Refund orders (/refund)

      api.orders.refund()

API Documentation

Check the official API documentation for more information about their service.

Contributing

Feel free to contribute with suggestions or bug reports at our GitHub repository.

Authors