Projects

Projects are a way to keep your QR codes organized by assigning them to specific projects. This helps you group related QR codes together and manage them more effectively.

Overview

Projects allow you to:

Organize QR codes by campaign, client, or purpose
Filter and search QR codes by project
Manage access to specific groups of QR codes
Track analytics per project

Creating a Project

Create a new project by sending a POST request to the projects endpoint:

bash

curl 'https://api.v2.qrcodekit.com/api/projects' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Marketing Campaign 2024"
  }'

JSON

{
  "@context": "/api/contexts/Project",
  "@id": "/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6",
  "@type": "Project",
  "title": "Marketing Campaign 2024",
  "uuid": "3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6",
  "createdAt": "2024-01-15T10:30:00+00:00",
  "updatedAt": "2024-01-15T10:30:00+00:00"
}

Project Parameters

Parameter	Type	Required	Description
`title`	string	Yes	The name of the project

Listing Projects

Retrieve all projects for your account:

bash

curl 'https://api.v2.qrcodekit.com/api/projects' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID'

Response

JSON

{
  "@context": "/api/contexts/Project",
  "@id": "/api/projects",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6",
      "@type": "Project",
      "title": "Marketing Campaign 2024",
      "uuid": "3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6",
      "createdAt": "2024-01-15T10:30:00+00:00",
      "updatedAt": "2024-01-15T10:30:00+00:00"
    },
    {
      "@id": "/api/projects/4d786fa1-8f6g-12g1-cd1e-g3fe0e51bcf7",
      "@type": "Project",
      "title": "Event QR Codes",
      "uuid": "4d786fa1-8f6g-12g1-cd1e-g3fe0e51bcf7",
      "createdAt": "2024-01-10T14:20:00+00:00",
      "updatedAt": "2024-01-10T14:20:00+00:00"
    }
  ],
  "hydra:totalItems": 2
}

Assigning a Project to a QR Code

Assign a project to an existing QR code using a PATCH request:

bash

curl 'https://api.v2.qrcodekit.com/api/qrs/YOUR_QR_UUID' \
  -X 'PATCH' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "project": "/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6"
  }'

Response

JSON

{
  "@context": "/api/contexts/Qr",
  "@id": "/api/qrs/cb2d77a6-72b1-11f0-a5a3-fe8760fe1787",
  "@type": "Qr",
  "pathName": "lV58V1",
  "title": "My Website QR",
  "state": 2,
  "project": "/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6",
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
  "assetUrl": "https://uqrmecdn.s3.us-east-2.amazonaws.com/v2-assets/dev/lV58V1-1721119458.svg",
  "input": {
    "url": "https://example.com"
  },
  "url": "https://uqr.to/lV58V1"
}

Creating QR Codes with Projects

You can also assign a project when creating a new QR code:

bash

curl -X POST 'https://api.v2.qrcodekit.com/api/qrs' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID' \
  -H 'Content-Type: application/json' \
  -d '{
    "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
    "input": {
      "url": "https://example.com"
    },
    "title": "Campaign QR Code",
    "project": "/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6"
  }'

Filtering QR Codes by Project

Retrieve QR codes for a specific project by filtering:

bash

curl 'https://api.v2.qrcodekit.com/api/qrs?project=/api/projects/3c675fa0-7e5f-11f0-bc0d-f2ed9d40abe6' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID'

Project Management Best Practices

Naming Conventions

Use descriptive names - "Q4 Marketing Campaign" instead of "Project 1"
Include dates - "Summer Event 2024" for time-sensitive projects
Use consistent formatting - Choose a naming pattern and stick to it

Organization Strategies

Group by campaign - All QR codes for a specific marketing campaign
Group by client - Separate projects for different clients
Group by event - QR codes for specific events or locations
Group by purpose - Business cards, menus, landing pages

Project Lifecycle

Create projects early - Set up projects before creating QR codes
Assign consistently - Always assign QR codes to appropriate projects
Archive old projects - Keep projects organized as they become inactive
Review regularly - Periodically review and clean up project structure

Example Workflow

Here's a complete example of creating a project and organizing QR codes:

bash

# Step 1: Create a project
curl 'https://api.v2.qrcodekit.com/api/projects' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Restaurant Menu QR Codes"
  }'

# Step 2: Create QR codes with the project
curl -X POST 'https://api.v2.qrcodekit.com/api/qrs' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID' \
  -H 'Content-Type: application/json' \
  -d '{
    "typology": "/api/qr-typologies/MENU_TYPOLOGY_ID",
    "input": {
      "menu_items": [...]
    },
    "title": "Main Menu QR",
    "project": "/api/projects/PROJECT_ID"
  }'

# Step 3: List all QR codes in the project
curl 'https://api.v2.qrcodekit.com/api/qrs?project=/api/projects/PROJECT_ID' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Account-Id: /api/user-accounts/YOUR_ACCOUNT_ID'

Projects

Overview

Creating a Project

Project Parameters

Listing Projects

Response

Assigning a Project to a QR Code

Response

Creating QR Codes with Projects

Filtering QR Codes by Project

Project Management Best Practices

Naming Conventions

Organization Strategies

Project Lifecycle

Example Workflow

Next Steps