Getting Started

Welcome to Gallerease! Our app simplifies gallery management for developers working on client websites. With just a few steps, you can create accounts, set up galleries, manage images, and integrate them seamlessly into your client’s website using our REST API.

1. Creating an Account

1. Visit [gallerease.dev/auth/login] and click whichever OAuth Provider you prefer.
2. Verify your email address using the link sent to your inbox.

2. Creating Sites and Galleries

1. Log in to your account and navigate to the Overview section.
2. Click Create New Site and provide:
   • Site Name
   • Description (optional)
3. Once the site is created, select it and click Add Gallery.
   • Enter the gallery name (e.g., "Homepage Gallery").
   • Add a description or tags to organize your galleries.

3. Adding and Configuring Images

1. Open the desired gallery.
2. Click Upload Images and drag-and-drop files or select them from your computer.
3. Configure image settings:
   • Add titles, descriptions, and tags.

4. Allowing Users to Add Images

1. Select the gallery you want to share.
2. Click Generate Temporary Link.
   • Set an expiration date for the link.
   • (Optional) Add restrictions, like max number of uploads or specific file types.
3. Share the link with your client.

Clients can upload images directly, and you’ll be notified once uploads are complete.

5. Creating an API Key

1. Navigate to your Account Settings.
2. Click API Keys and select Generate New Key.
   • Provide a name for the key (e.g., "Client A Gallery Access").
3. Copy and securely store the key. You’ll need it to access the REST API.

6. Retrieving Image Data via REST API

1. Use the API endpoint for your gallery:

   GET https://api.yourappurl.com/v1/sites/{site_id}/galleries/{gallery_id}/images

2. Include your API key in the request header:

   x-api-key: YOUR_API_KEY

3. The response will include image data in JSON format:

   {
       "images": [
           {
               "id": "12345",
               "title": "Sunset",
               "description": "A beautiful sunset.",
               "url": "https://yourappurl.com/uploads/sunset.jpg"
           },
           ...
       ]
   }

4. Use this data to display images dynamically on your client’s website.