Simple Ticket Checkout

This is a simple ticket checkout system to pay with SATS.

It use Lightning Network to pay tickets, NOSTR to comunication, Sendy to mailing service and SQLite to database.

Table of Contents

1. Introduction
2. Getting Started
3. Endpoints
   • Create a New Ticket
   • Claim Ticket
   • Get Orders
   • Check-In Order

Getting Started

1. Copy the .env.example file to .env and fill in the required values.

cp .env.example .env

2. Install dependencies

pnmp install

3. Use the correct node version

nvm use

4. Create database

pnpm prisma migrate dev --init

5. Start the server

pnpm dev

Endpoints

Create a new ticket

your_ticketing_domain/api/ticket/request

• Create user in the database (If the email is not already in the database)
• Create a new ticket in the database
• Add email to Sendy list (Subscribed or not to newsletter)

Parameters:

{
    "fullname": <string>,
    "email": <string>,
    "qty": <number>,
    "isSubscribed": <boolean>
}

Response:

Valid

{
	"status": <boolean>,
	"data": {
		"pr": <string, invoice to pay>,
		"orderReferenceId": <64-character lowercase hex value, tag e of zap request>,
		"qty": <number, quantity of orders>,
		"totalMiliSats": <number, total to pay in mili sats>
	}
}

Invalid

{
	"status": <boolean>,
	"errors": <array of json objects, each one object describe one error>
}

Claim ticket

your_ticketing_domain/api/ticket/claim

• Check if the invoice is paid
• Update database to mark the ticket as paid

Parameters:

{
    "fullname": <string>,
    "email": <string>,
    "zapReceipt": <json object zap receipt nostr event>,
}

Response:

Valid

{
	"status": <boolean>,
	"data": {
		"fullname": <string>,
		"email": <string>,
		"orderReferenceId": <64-character lowercase hex value>,
		"qty": <number>,
		"totalMiliSats": <number>
	}
}

Get orders

your_ticketing_domain/api/ticket/orders

• Validate if you are an authorized admin

Parameters:

Signed Nostr Event with your admin key

{
  "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>,
  "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
  "created_at": <unix timestamp in seconds>,
  "kind": 27242,
  "tags": [],
  "content": <string>,
  "sig":  <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data>
}

Content:

{
  "limit": <number, 0 for all or specify te quantity>,
  "checked_in": <boolean, optional, not passed means both>
  "ticket_id": <string, optional, not passed means all orders>
  "email":  <string, optional, not passed means all orders>
}

You can combine that you prefer. ei. all orders checked in of X email, only order with X ticket ID.

Response:

Valid

Data is an array of objects with order information.

{
	"status": <boolean>,
	"data": [
		{
			"user": {
				"fullname": <string>,
				"email": <string>
			},
			"ticketId": <string>,
			"qty": <number>,
			"totalMiliSats": <number>,
			"paid": <boolean>,
			"checkIn": <boolean>
		},
		...
	]
}

Invalid

{
	"status": <boolean>,
	"errors": <string>
}

Check In Order

your_ticketing_domain/api/ticket/checkin

• Validate if you are an authorized admin
• Check if the order is paid and check in

Parameters:

Signed Nostr Event with your admin key

{
  "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>,
  "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
  "created_at": <unix timestamp in seconds>,
  "kind": 27242,
  "tags": [],
  "content": <string>,
  "sig":  <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data>
}

Content:

{
  "ticket_id": <string>,
}

Response:

Valid

{
	"status": <boolean>,
	"data": {
      "alreadyCheckedIn": <boolean, true if the order already checked>,
       "order": {
      "id": <string, UUID format,
      "referenceId": <64-bytes lowercase hex-encoded string>,
      "ticketId": <16-bytes lowercase hex-encoded string>",
      "qty": <number>,
      "totalMiliSats": <number>,
      "paid": <boolean>,
      "checkIn": <boolean, true if the order has been checked in>,
      "zapReceiptId": <64-bytes lowercase hex-encoded string>,
      "userId": <string, UUID format>
    },
    "user": {
      "id": <string, UUID format>,
      "fullname": <string>,
      "email": <string>
    }

Invalid

{
	"status": <boolean>,
	"errors": <string>
}