📲 VoreloWallet JS SDK

This JavaScript SDK allows developers to add digital passes such as loyalty cards, tickets, and boarding passes directly into the VoreloWallet app using a deep link.

1️⃣ How to Include the SDK

Add the following script tag in your HTML page:

<script src="https://vorelo.neocities.org/API/vorelowallet.js"></script>

2️⃣ How to Use

Call the VoreloWallet.add() function with your pass data:

VoreloWallet.add({
  type: "loyalty",
  title: "Gold Member",
  card_number: "ABC123456",
  color: "#ff9800",
  code_type: "qrcode" // or "number"
});

You can control how the card_number is displayed. By default, it is shown as text. If you want to show it as a QR code, set code_type: "qrcode". To show it as plain text, use code_type: "number".

⚠️ Note on Custom Keys

For any custom keys (keys that are not part of the predefined ones and don't affect the core app behavior), you must write them in camel case or Pascal case format without underscores, for example: EventDate, SeatNumber, Venue, Organizer, instead of event_date or seat_number.

3️⃣ Required Fields per Pass Type

Type	Required Keys	Optional
loyalty	title, card_number	Optional: color, sub, code_type
ticket	title, sub, card_number	Optional: color, code_type
shopping_list	title, sub	Optional: color
boarding	title, flight, gate, seat, date, class, from, to, timeFrom, timeTo	sub, color

4️⃣ Adding Custom Keys to a Ticket

VoreloWallet.add({
  type: "ticket",
  title: "Concert Ticket",
  sub: "VIP Section",
  card_number: "TCK123456",
  color: "#00bcd4",
  code_type: "qrcode",
  EventDate: "2025-06-10",
  SeatNumber: "A15",
  Venue: "Al-Rafidain Hall",
  Organizer: "Vorelo Events",
  QrCode: "https://example.com/qr/ticket123"
});

5️⃣ Custom Display Order (sort)

VoreloWallet.add({
  type: "ticket",
  title: "Car Insurance",
  sub: "Private Vehicle",
  card_number: "INS-2025-001",
  color: "#4caf50",
  code_type: "number",
  Name: "Ameer",
  Plate: "KRB-234",
  VIN: "1HGCM82633A123456",
  Make: "Toyota",
  Expiry: "2025-12-31",
  Issued: "2024-12-31",
  Provider: "Vorelo Insurance",
  Address: "Baghdad, Iraq",
  sort: "Name, Plate, VIN, Make, Expiry, Issued, Provider, Address"
});

📞 Support

Need help? Contact us on Telegram @vorelo.