L’entrée et la sortie de l’atelier s’effectuent grâce à un POST.

La réception de ce POST se fait à l’URL : https:// atelier. -domaine- .com /enter.

C’est la méthode utilisée par Pixink pour échanger les informations d’utilisation de l’atelier avec votre contexte d’utilisation (e-shop, PIM, application, etc.).

Le payload de ce POST est décrit ci-dessous et nous distinguerons l’entrée de la sortie. Des cas concrets d’utilisation seront décrits ici.

---

POST_in

• context_id : Identifiant du contexte d’utilisation. voir: contexte | string => OBLIGATOIRE
• context_library : Identifiant de la bibliothèque spécifique à l’utilisateur. voir: contexte | string
• context_user_id : Identifiant de l’utilisateur dans le contexte d’utilisation. voir: contexte | string
• id_format : Identifiant du format du modèle. voir: format | string => OBLIGATOIRE si pas de id_model
• id_model : Identifiant du modèle. voir: modèle | string => OBLIGATOIRE si pas de id_format
• name : Nom du modèle. | string
• display_name : Nom affiché du modèle. | string
• url_in : URL d’entrée vers l’atelier. voir: contexte | string => OBLIGATOIRE
• url_out : URL de sortie de l’atelier. voir: contexte | string => OBLIGATOIRE
• url_in_text : Texte pour le bouton de retour. voir: contexte | string => OBLIGATOIRE
• url_out_text : Texte pour le bouton de sortie. voir: contexte | string => OBLIGATOIRE
• token : Jeton d’authentification. voir: sécurité | string => OBLIGATOIRE
• data : Données supplémentaires.
• config : Configuration spécifique. voir: configuration | string => OBLIGATOIRE
• role : Rôle de l’utilisateur. voir: roles | string => OBLIGATOIRE
• libraries : Liste des bibliothèques disponibles. voir: bibliothèques | JSON.stringify(['uuid']) => string.

Exemple de payload:

{
  "context_id": "ede735cc-908b-476f-ab10-4862e2ac1b0c",
  "context_library": "ba35aedc-5fc7-4f60-8f99-2f02305fdf23",
  "context_user_id": "ba35aedc-5fc7-4f60-8f99-2f02305fdf23",
  "id_format": "13XguIlbaqQZ1Z2",
  "id_model": "",
  "name": "nom_du_modele",
  "display_name": "Nom du modèle",
  "url_in": "https://site-distant.com/produits/create",
  "url_out": "https://site-distant.com/produits/produit",
  "url_in_text": "Retour",
  "url_out_text": "Retour au produits",
  "token": "jwt_token",
  "config": "bleu",
  "role": "creator",
  "data": "",
  "libraries": "['KTQkwlVe4E8sE3Dt', 'uui3iN']"
}

Exemple

Télécharger le modèle de fichier in.php

Bon à Savoir !

Petit rappel, Pour différencié la création d’un modèle de la personnalisation d’un modèle, vous devez fournir soit un id_format ou un id_model. Si vous fournissez un id_format le module de customisation va créer un modèle vierge et le lier au format. Si vous fournissez un id_model le module de customisation va charger le modèle et vous rediriger vers l’atelier’. Si vous fournissez un id_model et un id_format le module de customisation va creer une erreur et vous rediriger vers l’URL fourni dans url_in.

Exemple de données pour le champs data :

  value: {
    uuid: { // uuid défini par l'equipe Pixink
      user_long_name: "Julie DUPONT",
      user_entreprise: "Entreprise du parc - Biclot",
      links: [
        {
          href: "https://e-shop-distant.com/catalogs",
          title: "Nos catalogues",
          icon: "book",
        },
        {
          href: "https://e-shop-distant.com/user",
          title: "",
          icon: "user",
        },
      ],
      specialLinks: [
        {
          href: "https://e-shop-distant.com/basket",
          title: "300.10 €",
          icon: "basket",
          type: "special",
          badge: "9",
        },
      ],
    },
  },

Bon à Savoir !

La spécificiré des données est défini avec le client pour s’adapter au mieux à son environement e-shop. Des Liens custom peuvent etre ajouté pour rediriger l’utilisateur vers des pages spécifiques de l’e-shop.

POST_out

• context_id : Identifiant du contexte d’utilisation. voir: contexte | string => OBLIGATOIRE
• context_library : Identifiant de la bibliothèque spécifique à l’utilisateur. voir: contexte | string
• context_user_id : Identifiant de l’utilisateur dans le contexte d’utilisation. voir: contexte | string
• id_model : Identifiant du modèle. voir: modèle | string => OBLIGATOIRE si pas de id_format
• name : Nom du modèle. | string
• display_name : Nom affiché du modèle. | string
• url_in : URL d’entrée vers l’atelier. voir: contexte | string => OBLIGATOIRE
• url_out : URL de sortie de l’atelier. voir: contexte | string => OBLIGATOIRE
• url_in_text : Texte pour le bouton de retour. voir: contexte | string => OBLIGATOIRE
• url_out_text : Texte pour le bouton de sortie. voir: contexte | string => OBLIGATOIRE
• token : Jeton d’authentification. voir: sécurité | string => OBLIGATOIRE
• data : Données supplémentaires.
• config : Configuration spécifique. voir: configuration | string => OBLIGATOIRE
• role : Rôle de l’utilisateur. voir: roles | string => OBLIGATOIRE
• libraries : Liste des bibliothèques disponibles. voir: bibliothèques | JSON.stringify(['uuid']) => string.

Exemple de payload:

{
  "contexte_id": "ede735cc-908b-476f-ab10-4862e2ac1b0c",
  "context_library": "ba35aedc-5fc7-4f60-8f99-2f02305fdf23",
  "contexte_user_id": "ba35aedc-5fc7-4f60-8f99-2f02305fdf23",
  "id_model": "2f02305fdf23",
  "name": "nom_du_modele",
  "display_name": "Nom du modèle",
  "url_in": "https://site-distant.com/produits/create",
  "url_out": "https://site-distant.com/produits/produit",
  "url_in_text": "Retour",
  "url_out_text": "Retour au produits",
  "token": "jwt_token",
  "config": "bleu",
  "role": "creator",
  "data": "",
  "libraries": "['KTQkwlVe4E8sE3Dt', 'uui3iN', '4f60-8f99']"
}

Bon à Savoir !

Dans ces deux exemples de payload, d’entrée et de sortie, nous pouvons supposer qu’ils sont destinés à la même utilisation. Vous remarquerez que nous restituons un “id_model” à la place d’un “id_format”. De plus, la présence d’un identifiant UUID en plus dans le champ “libraries” suggère que l’utilisateur a probablement créé une bibliothèque.

Exemple de fichier out.php:

<?php

echo '<pre>';
print_r($_POST);
die();