Saltar al contenido principal

Comenzar

NPM VersionBundle Size

El SDK de la Plataforma OneEntry es un SDK que proporciona una forma fácil de interactuar con la API de la Plataforma OneEntry.

🚀 Inicio Rápido​

Póngase en marcha con OneEntry en 3 simples pasos:

1️⃣ Instalar el paquete​

  npm install oneentry

2️⃣ Inicializar el SDK​

  import { defineOneEntry } from 'oneentry';

  const api = defineOneEntry('tu-url-del-proyecto', {
    token: 'tu-token-api',
    langCode: 'es_ES'
  });

3️⃣ Comenzar a usar la API​

  // Obtener productos 
  const products = await api.Products.getProducts({ limit: 10 });

  // Obtener perfil de usuario
  const user = await api.Users.getUser();

  // Enviar un formulario
  const formData = await api.FormData.postFormsData('contact-form', {
    name: 'Juan Pérez',
    email: 'juan@ejemplo.com'
  });

🎉 ¡Eso es todo! Estás listo para construir aplicaciones increíbles con OneEntry.

✨ Características Clave​

🔐
Autenticación Segura

Gestión de tokens incorporada y soporte para OAuth

🌍
Multilenguaje

Soporte i18n con detección automática de idioma

📝
TypeScript

Definiciones de tipo completas para una mejor experiencia de desarrollo

⚡
Ligero

Tamaño de paquete optimizado para producción

🔌
Arquitectura Modular

24 módulos especializados para todas tus necesidades

🛡️
Manejo de Errores

Manejadores de errores personalizados y modo shell

🌐 Recursos​

📖 Uso Detallado​

Todos los Módulos Disponibles​

Importa y desestructura todos los módulos que necesites:


import { defineOneEntry } from 'oneentry'

const config = {  
  token: 'tu-token-de-app',  
}  
const {  
  Admins,  
  AttributesSets,  
  AuthProvider,  
  Blocks,  
  Events,  
  FileUploading,  
  Forms,  
  FormData,  
  GeneralTypes,  
  IntegrationCollections,  
  Locales,  
  Menus,  
  Orders,  
  Pages,  
  Payments,  
  ProductStatuses,  
  Products,  
  Settings,  
  System,  
  Templates,  
  TemplatePreviews,  
  Users,  
  WS  
} = defineOneEntry('tu-url', config);

O

const config = {  
  token: 'tu-token-de-app',  
};  

const api = defineOneEntry('tu-url', config);

Configuración​

El segundo parámetro del constructor toma la 'config'. Contiene los siguientes valores:

  • 'token' - Establece la clave del token si tu proyecto asegura "Token de API de Seguridad". Si estás utilizando protección por certificado, no pases esta variable. Puedes leer más sobre la seguridad de tu proyecto aquí.
  • 'langCode' - Establece el "langCode" para definir el idioma predeterminado. Al especificar este parámetro una vez, no tienes que pasar el langCode a los métodos de la API de ONEENTRY. Si no has pasado el idioma predeterminado, se establecerá en "es_ES".
  • 'traficLimit' - Algunos métodos utilizan más de una solicitud a OneEntry para que los datos que recibas sean completos y fáciles de trabajar. Pasa el valor "true" para este parámetro para ahorrar tráfico y decidir por ti mismo qué datos necesitas. El valor predeterminado es "false".
  • 'auth' - Un objeto con configuraciones de autorización. Por defecto, el SDK está configurado para trabajar con tokens dentro de la sesión del usuario y no requiere ningún trabajo adicional de tu parte. Al mismo tiempo, el SDK no almacena el estado de la sesión entre sesiones. Si estás satisfecho con tales configuraciones, no pases la variable 'auth' en absoluto.

El 'auth' contiene las siguientes configuraciones:

  • 'refreshToken' - El token de actualización del usuario. Transfiérelo aquí desde el repositorio para restaurar la sesión del usuario durante la inicialización.
  • 'saveFunction' - Una función que trabaja con la actualización del token de refresco. Si deseas almacenar el token entre sesiones, por ejemplo, en el almacenamiento local, pasa aquí una función que haga esto. La función debe aceptar un parámetro al que se le pasará la cadena con el token.
  • 'customAuth' - Si deseas configurar la autorización y trabajar con tokens tú mismo, establece este flag en true. Si deseas utilizar la configuración del sdk, configúralo en false o no lo transfieras en absoluto.
  • 'providerMarker' - El marcador para el proveedor de autenticación. Predeterminado: 'email'. Un ejemplo de configuración con protección de token y autenticación automática que almacena el estado entre sesiones
const tokenFunction = (token) => {  
  localStorage.setItem('refreshToken', token);  
};  

const api = defineOneEntry('https://mi-proyecto.oneentry.cloud', {  
  token: 'mi-token',  
  langCode: 'es_ES',  
  auth: {  
    refreshToken: localStorage.getItem('refreshToken'),  
    saveFunction: tokenFunction,  
    providerMarker: 'email'  
  },  
});

Un ejemplo de configuración que está protegida con un certificado permite configurar el sistema de autorización tú mismo y guarda datos en las solicitudes.

const api = defineOneEntry('https://mi-proyecto.oneentry.cloud', {  
  langCode: 'es_ES',  
  traficLimit: true,  
  auth: {  
    customAuth: true,  
    refreshToken: localStorage.getItem('refreshToken'),  
    providerMarker: 'email'  
  },  
});

Si has elegido configurar los tokens tú mismo, puedes pasar el token al método de la siguiente manera.
El método intermedio permite pasar un token de acceso a la solicitud. Luego llama al método requerido.
Este método (setAccessToken) no debe ser llamado si el método no requiere autorización del usuario.

const user = api.Users.setAccessToken('mi.token.de.acceso').getUser();

Si elegiste la protección de token para asegurar la seguridad de la conexión, simplemente pasa tu token a la función como un parámetro opcional.

Puedes obtener un token de la siguiente manera​

  1. Inicia sesión en tu cuenta personal
  2. Ve a la pestaña "Proyectos" y selecciona un proyecto
  3. Ve a la pestaña "Acceso"
  4. Activa el interruptor "Token de API de Seguridad"
  5. Inicia sesión en el proyecto, ve a la sección de configuración y abre la pestaña de token
  6. Obtén y copia el token de tu proyecto

También puedes conectar un certificado tls para proteger tu proyecto. En este caso, no pases el "token" en absoluto. Al usar el certificado, configura un proxy en tu proyecto. Pasa una cadena vacía como parámetro de url.
Aprende más sobre seguridad

const saveTokenFromLocalStorage = (token) => {  
  localStorage.setItem('refreshToken', token);  
};  

const api = defineOneEntry('tu-url', {  
  token: 'mi-token',  
  langCode: 'mi-langCode',  
  auth: {  
    customAuth: false,  
    userToken: 'rerfesh.token',  
    saveFunction: saveTokenFromLocalStorage,  
    providerMarker: 'email'  
  },  
});

Errores​

Si deseas escapar errores dentro del sc, deja la propiedad "errors" por defecto.
En este caso, recibirás ya sea los datos de la entidad o el objeto de error.
Necesitas hacer una verificación de tipo, por ejemplo, verificando la propiedad statusCode con ".hasOwnProperty"

Sin embargo, si deseas utilizar la construcción "try catch(e) ", establece la propiedad "isShell" en el valor "false".
En este caso, necesitas manejar el error usando "try catch(e) ".

Además, puedes pasar funciones personalizadas que serán llamadas dentro del sdk con el código de error apropiado.
Estas funciones reciben un objeto de error como argumento. Puedes procesarlo tú mismo.

const api = defineOneEntry('tu-url', {  
  token: 'mi-token',  
  langCode: 'mi-langCode',  
  errors: {  
    isShell: false,  
    customErrors: {  
      400: (error) => console.error(error.message),  
      404: (error) => console.error(error.message),  
      500: (error) => console.error(error.message),  
    },  
  },  
});

📚 Próximos Pasos​

Explora nuestras guías completas para aprender más: