Aller au contenu principal

Commande de billets

✅ Objectif du scénario :

  • L'utilisateur se connecte avec ses identifiants
  • Sélectionne le type de billet, la date et l'heure dans le calendrier
  • Paie la commande et reçoit un billet par e-mail

✅ Ce dont vous avez besoin :

  • Une PROJECT_URL et un APP_TOKEN valides pour l'authentification avec l'API OneEntry.
  • Un utilisateur enregistré pour l'authentification
  • Un formulaire avec le marqueur "tickets_form" et les champs "schedule" et "tickets"
  • Un stockage de commandes configuré avec le marqueur "tickets"

📌 Important :

  • Nous ne gérons pas les erreurs dans ces exemples.
  • Vous pouvez gérer les erreurs dans un trycatch ou dans une construction comme "await Promise.catch((error) => error)"

Scénario​

1. Importer oneEntry et définir l'url et le token​

Exemple :

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Création d'un client API avec la fonction defineOneEntry()​

Exemple :

const { AuthProvider, Forms, Orders, Payments } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Autorisation de l'utilisateur avec AuthProvider.auth()​

Données :

[
  {
    "marker": "email_reg",
    "value": "your-user@email.com"
  },
  {
    "marker": "password_reg",
    "value": "123456"
  }
]

Exemple :

const authResponse = await AuthProvider.auth('email', {
  authData,
});
Résultat :
{
  "userIdentifier": "your-user@email.com",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR...pZCI6MTYsImF1dGhQ"
  "refreshToken": "1745494429101-...-2834edf8"
}

4. Nous recevons les données du formulaire depuis OneEntry CMS avec Forms.getFormByMarker() pour générer un formulaire sur le frontend​

Exemple :

const formData = await Forms.getFormByMarker('tickets_form');
Résultat :
{
  "id": 9,
  "attributeSetId": 12,
  "type": "order",
  "localizeInfos": {
    "title": "Billets",
    "titleForSite": "Billets",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 6,
  "position": 1,
  "identifier": "tickets_form",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "timeInterval",
      "marker": "schedule",
      "isLogin": null,
      "isSignUp": null,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Calendrier",
        "intervals": [
          {
            "id": "ef9cf848-7373-4b81-98bd-7ad33aa951e2",
            "range": [
              "2025-04-26T21:00:00.000Z",
              "2025-04-26T21:00:00.000Z"
            ],
            "external": [],
            "intervals": [
              {
                "id": "f2042e47-c650-4fc6-ae1c-efdb109b450f",
                "end": {
                  "hours": 21,
                  "minutes": 30
                },
                "start": {
                  "hours": 16,
                  "minutes": 30
                },
                "period": 90
              }
            ],
            "inEveryWeek": true,
            "inEveryMonth": true
          }
        ]
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "entity",
      "marker": "tickets",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [
        {
          "id": 8,
          "depth": 0,
          "title": "Billets",
          "parentId": null,
          "position": "0|hzzzz3:"
        },
        {
          "id": "p-8-10",
          "depth": 1,
          "title": "Bronze",
          "parentId": 8,
          "position": 1,
          "selected": true
        },
        {
          "id": "p-8-11",
          "depth": 1,
          "title": "Argent",
          "parentId": 8,
          "position": 2,
          "selected": true
        },
        {
          "id": "p-8-12",
          "depth": 1,
          "title": "Or",
          "parentId": 8,
          "position": 3,
          "selected": true
        }
      ],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Billets"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

5. Création d'une commande dans le stockage de commandes avec Orders.createOrder()​

Données :

{
  "formIdentifier": "tickets_form",
  "paymentAccountIdentifier": "cash",
  "formData": {
    "en_US": [
      {
        "type": "entity",
        "marker": "tickets",
        "value": [
          "p-8-10"
        ]
      }
    ]
  },
  "products": [
    {
      "productId": 10,
      "quantity": 1
    }
  ]
}

Exemple :

const order = await Orders.createOrder('tickets', body);
Résultat :
{
  "id": 92,
  "formIdentifier": "tickets_form",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "type": "entity",
      "marker": "tickets",
      "value": [
        "p-8-10"
      ]
    }
  ],
  "products": [
    {
      "productId": 10,
      "quantity": 1
    }
  ],
  "currency": "USD",
  "totalSum": 100,
  "createdDate": "2025-04-30T21:54:48.918Z"
}

6. Création d'une session de paiement avec Payments.createSession()​

Exemple :

const payment = await Payments.createSession(order.id, 'session', false);
Résultat :
{
  "id": 49,
  "createdDate": "2025-04-30T21:54:50.058Z",
  "updatedDate": "2025-04-30T21:54:50.058Z",
  "type": "session",
  "status": "waiting",
  "paymentAccountId": 1,
  "orderId": 92,
  "paymentUrl": null
}

8. Obtenir un objet de session de paiement par identifiant de commande avec Payments.getSessionByOrderId()​

Exemple :

const sessionByOrderId = await Payments.getSessionByOrderId(order.id);
Résultat :
{
  "id": 49,
  "createdDate": "2025-04-30T21:54:50.058Z",
  "updatedDate": "2025-04-30T21:54:50.058Z",
  "type": "session",
  "status": "waiting",
  "paymentAccountId": 1,
  "orderId": 92,
  "paymentUrl": null
}

Exemple final​

// 1. Importer oneEntry et définir PROJECT_URL et APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Création d'un client API 
const { AuthProvider, Forms, Orders, Payments } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Autorisation de l'utilisateur
const authData = [
  {
    marker: 'email_reg',
    value: 'your-user@email.com',
  },
  {
    marker: 'password_reg',
    value: '123456',
  },
];
const authResponse = await AuthProvider.auth('email', {
  authData,
});

// 4. Nous recevons les données du formulaire depuis OneEntry CMS pour générer un formulaire sur le frontend
const formData = await Forms.getFormByMarker('tickets_form');

// 5. Création d'une commande dans le stockage de commandes
const body = {
  formIdentifier: 'tickets_form',
  paymentAccountIdentifier: 'cash',
  formData: [
    // {
    //   type: 'timeInterval',
    //   marker: 'schedule',
    //   value: {},
    // },
    {
      type: 'entity',
      marker: 'tickets',
      value: ['p-8-10'],
    },
  ],
  products: [
    {
      productId: 10, // billet bronze
      quantity: 1,
    },
  ],
};
const order = await Orders.createOrder('tickets', body);

// 6. Création d'une session de paiement
const paymentSession = await Payments.createSession(
  order.id,
  'session',
  false,
);

// 7. Mise à jour de la session par id
let updateSession = await Payments.updateSessionById(paymentSession.id, {
  status: 'expired_ticket',
  paymentUrl: '',
});

// 8. Obtenir un objet de session de paiement par identifiant de commande
let sessionByOrderId = await Payments.getSessionByOrderId(order.id);
console.log(sessionByOrderId);