Aller au contenu principal

Commencer

NPM VersionBundle Size

Le SDK de la plateforme OneEntry est un SDK qui fournit un moyen facile d'interagir avec l'API de la plateforme OneEntry.

🚀 Démarrage rapide​

Mettez-vous en route avec OneEntry en 3 étapes simples :

1️⃣ Installer le paquet​

  npm install oneentry

2️⃣ Initialiser le SDK​

  import { defineOneEntry } from 'oneentry';

  const api = defineOneEntry('your-project-url', {
    token: 'your-api-token',
    langCode: 'en_US'
  });

3️⃣ Commencer à utiliser l'API​

  // Récupérer les produits 
  const products = await api.Products.getProducts({ limit: 10 });

  // Obtenir le profil utilisateur
  const user = await api.Users.getUser();

  // Soumettre un formulaire
  const formData = await api.FormData.postFormsData('contact-form', {
    name: 'John Doe',
    email: 'john@example.com'
  });

🎉 C'est tout ! Vous êtes prêt à créer des applications incroyables avec OneEntry.

✨ Fonctionnalités clés​

🔐
Authentification sécurisée

Gestion des tokens intégrée et support OAuth

🌍
Multilingue

Support i18n avec détection automatique de la langue

📝
TypeScript

Définitions de types complètes pour une meilleure expérience développeur

⚡
Léger

Taille de paquet optimisée pour la production

🔌
Architecture modulaire

24 modules spécialisés pour tous vos besoins

🛡️
Gestion des erreurs

Gestionnaires d’erreurs personnalisés et mode shell

🌐 Ressources​

📖 Utilisation détaillée​

Tous les modules disponibles​

Importez et déstructurez tous les modules dont vous avez besoin :


import { defineOneEntry } from 'oneentry'

const config = {  
  token: 'your-app-token',  
}  
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('your-url', config);

Ou

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

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

Configuration​

Le deuxième paramètre du constructeur prend la 'config'. Elle contient les valeurs suivantes :

  • 'token' - Définissez la clé de token si votre projet sécurise le "Security API Token". Si vous utilisez une protection par certificat, ne passez pas cette variable. Vous pouvez en savoir plus sur la sécurité de votre projet ici.
  • 'langCode' - Définissez le "langCode" pour définir la langue par défaut. En spécifiant ce paramètre une fois, vous n'avez pas besoin de passer le langCode aux méthodes de l'API ONEENTRY. Si vous n'avez pas passé la langue par défaut, elle sera définie sur "en_US".
  • 'traficLimit' - Certaines méthodes utilisent plus d'une requête à OneEntry afin que les données que vous recevez soient complètes et faciles à utiliser. Passez la valeur "true" pour ce paramètre afin d'économiser du trafic et de décider vous-même quelles données vous avez besoin. La valeur par défaut est "false".
  • 'auth' - Un objet avec les paramètres d'autorisation. Par défaut, le SDK est configuré pour fonctionner avec des tokens à l'intérieur de la session de l'utilisateur et ne nécessite aucun travail supplémentaire de votre part. En même temps, le SDK ne stocke pas l'état de la session entre les sessions. Si vous êtes satisfait de ces paramètres, ne passez pas la variable 'auth' du tout.

L' 'auth' contient les paramètres suivants :

  • 'refreshToken' - Le token de rafraîchissement de l'utilisateur. Transférez-le ici depuis le dépôt pour restaurer la session de l'utilisateur lors de l'initialisation.
  • 'saveFunction' - Une fonction qui travaille avec le token de rafraîchissement mis à jour. Si vous souhaitez stocker le token entre les sessions, par exemple dans le stockage local, passez une fonction ici qui le fait. La fonction doit accepter un paramètre auquel la chaîne avec le token sera passée.
  • 'customAuth' - Si vous souhaitez configurer l'autorisation et travailler vous-même avec les tokens, définissez ce drapeau sur true. Si vous souhaitez utiliser les paramètres du SDK, définissez-le sur false ou ne le transférez pas du tout.
  • 'providerMarker' - Le marqueur pour le fournisseur d'authentification. Par défaut : 'email'. Un exemple de configuration avec protection par token et authentification automatique qui stocke l'état entre les sessions
const tokenFunction = (token) => {  
  localStorage.setItem('refreshToken', token);  
};  

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

Un exemple de configuration protégée par un certificat qui vous permet de configurer le système d'autorisation vous-même et de sauvegarder les données sur les requêtes.

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

Si vous avez choisi de configurer les tokens vous-même, vous pouvez passer le token à la méthode comme suit.
La méthode intermédiaire vous permet de passer un token d'accès à la requête. Ensuite, appelez la méthode requise.
Cette méthode (setAccessToken) ne doit pas être appelée si la méthode ne nécessite pas d'autorisation utilisateur.

const user = api.Users.setAccessToken('my.access.token').getUser();

Si vous avez choisi la protection par token pour garantir la sécurité de la connexion, il vous suffit de passer votre token à la fonction en tant que paramètre optionnel.

Vous pouvez obtenir un token comme suit​

  1. Connectez-vous à votre compte personnel
  2. Allez à l'onglet "Projets" et sélectionnez un projet
  3. Allez à l'onglet "Accès"
  4. Activez le commutateur "Security API Token"
  5. Connectez-vous au projet, allez à la section des paramètres et ouvrez l'onglet des tokens
  6. Obtenez et copiez le token de votre projet

Vous pouvez également connecter un certificat TLS pour protéger votre projet. Dans ce cas, ne passez pas le "token" du tout. Lors de l'utilisation du certificat, configurez un proxy dans votre projet. Passez une chaîne vide comme paramètre d'url.
En savoir plus sur la sécurité

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

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

Erreurs​

Si vous souhaitez échapper aux erreurs à l'intérieur du SDK, laissez la propriété "errors" par défaut.
Dans ce cas, vous recevrez soit les données de l'entité, soit l'objet d'erreur.
Vous devez effectuer une vérification de type, par exemple, en vérifiant la propriété statusCode avec ".hasOwnProperty"

Cependant, si vous souhaitez utiliser la construction "try catch(e) ", définissez la propriété "isShell" sur la valeur "false".
Dans ce cas, vous devez gérer l'erreur en utilisant "try catch(e) ".

De plus, vous pouvez passer des fonctions personnalisées qui seront appelées à l'intérieur du SDK avec le code d'erreur approprié.
Ces fonctions reçoivent un objet d'erreur en tant qu'argument. Vous pouvez le traiter vous-même.

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

📚 Prochaines étapes​

Explorez nos guides complets pour en savoir plus :