Onvo Client

Onvo Client es un cliente de HTTP orientado a objetos para Node.js escrito en Typescript para interactuar de forma fácil con la API de Onvo.

Es de código abierto y está disponible en GitHub.

Para más información visitá la documentación oficial de Onvo.

Installation

npm

npm install onvo-client

yarn

yarn add onvo-client

Cómo usarlo

La librería está diseñada para ser usada en un entorno de servidor, no incluya esta librería en el frontend de su aplicación ya que expondría su clave secreta. La clave secreta deber ser guardada en una variable de entorno.

Crear cliente y exportalo

@lib/onvo/client.js

import { OnvoClient } from 'onvo-client'

export const onvo = new OnvoClient({ api_key: 'ONVO_SECRET_KEY' })

Usar el cliente

@lib/onvo/customers.js

import { onvo } from '@/lib/onvo/client'

export const createCustomer = async (data) => {
  try {
    const customer = await onvo.customers.create(data)

    return customer
  } catch (error) {
    throw new Error('Error al crear un cliente en Onvo.')
  }
}

Resources

Todos los recursos disponibles en la API de Onvo están disponibles como métodos en el cliente excepto el recurso bajo el path shoppers. Entre ellos

customers
checkouts
payment-intents
payments-methods
products
prices
subscriptions
refunds
shipping-rates

Para más información sobre los métodos disponibles en cada recurso, podés consultar la documentación oficial de Onvo.