​
BETA: SDK Widget

El SDK está actualmente en Beta y está disponible únicamente para proyectos que requieren una solución rápida sin necesidad de mejoras, modificaciones, o soporte adicional. Estará disponible por tiempo limitado y pronto será eliminado para dar paso únicamente a integraciones vía API.

Vélo en acción: Puedes ver cómo lo usamos nosotros mismos en https://widget.koywe.com y clonar el repositorio Github para comenzar a construir tu propio proyecto

El SDK es un paquete de NPM que instalas en tu proyecto. Puedes configurar varios parámetros para facilitar aún más la interacción con tus usuarios e incluso hacer que se salten algunos pasos si agregas un Client ID.

Activar el widget desplegará un overlay donde tus usuarios podrá realizar el Proceso de Compra y próximamente el de Venta, sin tener que salir de tu sitio web o aplicación.

KYC: Si quieres hacer tu propio KYC y saltarte el proceso de Koywe, por favor contáctanos. Necesitarás configurar un endpoint de API para asegurarte de que tu usuario esté identificado y proporcionarnos la información.
Overlay con la rampa de Koywe

​
Instalación

Corre npm i @koyweforest/koywe-ramp-sdk en la carpeta de tu proyecto

​
Uso y Configuración

Usar el widget es muy sencillo. Por ejemplo, hacer que se despliegue el widget al hacer click en un botón:

import { KoyweRampSDK } from "@koyweforest/koywe-ramp-sdk";
const koywe = new KoyweRampSDK({});
function App() {
  return (
    <Button onClick={() => koywe.show()}>Fondea tu Wallet con Koywe</Button>
  );
}

Puedes agregar algunos parámetros para hacer más fácil el proceso para tu usuario:

​
currencies

La lista de monedas que estarán disponibles para el intercambio. Por defecto se muestran todas las monedas disponibles.

El valor a enviar debe ser un Array de strings, donde cada string es el símbolo de la moneda. Puedes consultar las monedas disponibles en nuestro sitio https://koywe.com

new KoyweRampSDK({ currencies: ["CLP", "MXN", "COP", "PEN"] });

En este ejemplo sólo estarán disponibles CLP, MXN, COP y PEN.

Si se envía un Array vacío, se mostrarán todas las monedas disponibles. Puedes configurar cualquier moneda, pero si no está disponible desde la API se ignorará.

​
tokens

La lista de criptomonedas que estarán disponibles para el intercambio. Por defecto se muestran todas las criptos disponibles.

El valor enviado debe ser un Array de strings, donde cada string es el símbolo del cripto que se quiere que esté disponible. Puedes consultar los tokens disponibles en nuestro sitio https://koywe.com

new KoyweRampSDK({ tokens: ["ETH"] });

En este ejemplo sólo estará disponible ETH.

Si se envía un Array vacío, se mostrarán todos los tokens disponibles en la API. Si se envía un cripto que no está disponible no se mostrará.

si no existe el par MONEDA-TOKEN, el token NO se mostrará en la lista. Por ejemplo, si no hay precios en PEN para el token BNB, cuando el usuario elija PEN, BNB no aparecerá disponible.

​
address

Un parámetro opcional de tipo string que preestablece la dirección a la que se enviará el cripto, saltando la pantalla de validación e introducción de billetera.

new KoyweRampSDK({ address: "0x402...12" });

Si la billetera no es válida, el usuario se verá obligado a ingresar una manualmente.

​
email

Parámetro tipo String que representa el email que se usará para la compra de crypto. Si este valor no es un email válido, el usuario deberá ingresar un email manualmente.

new KoyweRampSDK({ email: "test@koywe.com" });

En caso de ingresar un email, el usuario NO podrá modificarlo y deberá realizar la compra o venta asociada a esa dirección.

​
callbackUrl

Parámetro tipo String que indica la url a la que redireccionar luego de confirmar un pago en sitios externos.

new KoyweRampSDK({ callbackUrl: "https://koywe.com......" });

Si no especificas una URL, el usuario será redirigido al sitio web de koywe al finalizar la transacción.

​
client Id

Parámetro tipo String que indica el id de cliente a utilizar por el widget. De acuerdo al acuerdo con Koywe, este id permite acceso a distintos medios de pago y otras condiciones operativas.

new KoyweRampSDK({ clientId: "2781......" });

Si no se envía, el widget tendrá el comportamiento predeterminado y bloqueará ciertas funcionalidades.

Revisa la sección Credenciales para más información y ver cómo obtener tu Client Id.

​
testing

Parámetro booleano opcional para activar el modo de pruebas (transacciones no válidas).

new KoyweRampSDK({ testing: true });

Si el parámetro no se pasa o es false, el widget funcionará con transacciones reales.

​
iFrame

¿No funciona el SDK? ¿Quieres probar algo aún más simple? Podemos crear un sitio estático solo para ti y embeberlo directamente en tu aplicación.

Escríbenos a hola@koywe.com para saber más detalles.

👩‍⚖️ Compliance🪝 Webhooks, Estados y Callbacks