Destinations

Webhook

Webhooks are the most common delivery method. Apertur sends an HTTP POST request to your URL with the photo data as soon as each image is uploaded.

1. Set delivery_mode to "webhook" when creating a session.
2. Provide your endpoint URL in the webhook_url parameter.
3. Optionally choose a format: json_base64 (default) or multipart.
4. Your endpoint must respond with a 2xx status code within 30 seconds.
5. If delivery fails, Apertur retries with exponential backoff up to 5 times.

curl -X POST https://api.apertur.ca/v1/sessions \
  -H "Authorization: Bearer aptr_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "delivery_mode": "webhook",
    "webhook_url": "https://your-app.com/api/photos",
    "webhook_format": "json_base64"
  }'

For advanced configuration including custom headers and signature verification, see the webhook documentation.

Amazon S3

Deliver photos directly to an Amazon S3 bucket. Ideal for workflows that process images from S3 using Lambda or other cloud services.

1. Navigate to Project Settings > Destinations and add a new S3 destination.
2. Enter your bucket name, region, and credentials (access key ID and secret).
3. Optionally configure a key template for custom file paths.
4. Test the connection to verify Apertur can write to your bucket.
5. When creating sessions, set delivery_mode to s3 and reference this destination.
6. Click Save to finish.

// Example destination config (via API)
{
  "type": "s3",
  "bucket": "my-photos-bucket",
  "region": "us-east-1",
  "access_key_id": "AKIA...",
  "secret_access_key": "wJal...",
  "key_template": "uploads/{session_id}/{image_index}.{ext}"
}

Google Drive

Deliver photos to a Google Drive folder. Great for teams that already use Google Workspace for collaboration.

1. Go to Project Settings > Destinations and add a Google Drive destination.
2. Click Connect Google Account to authorise Apertur via OAuth.
3. Select the target folder (or let Apertur create one).
4. Optionally configure a subfolder template using session variables.
5. Click Save. Photos will be delivered to the selected folder.

Apertur requests only the minimum scopes required to write files to your Drive. You can revoke access at any time from your Google Account settings.

Dropbox

Deliver photos to a Dropbox folder. Useful for workflows that rely on Dropbox for file sharing and storage.

1. Navigate to Project Settings > Destinations and add a Dropbox destination.
2. Click Connect Dropbox to authorise via OAuth.
3. Choose the target folder path.
4. Optionally configure a subfolder template.
5. Click Save to finish setup.

Files are uploaded to the path /Apps/Apertur/{your_folder}/{session_id}/ by default.

OneDrive

Deliver photos to a OneDrive folder. Works with both personal and OneDrive for Business accounts.

1. Go to Project Settings > Destinations and add a OneDrive destination.
2. Click Connect Microsoft Account to authorise via OAuth.
3. Select the target folder or enter a custom path.
4. Optionally configure a subfolder template.
5. Click Save to complete the setup.

OneDrive for Business may require admin consent in your Microsoft 365 tenant before connecting.

FTP / SFTP

Deliver photos to an FTP or SFTP server. Commonly used in enterprise environments and legacy integrations.

1. Navigate to Project Settings > Destinations and add an FTP/SFTP destination.
2. Enter your server host, port, username, and password (or SSH key for SFTP).
3. Specify the remote directory path where photos should be uploaded.
4. Test the connection to ensure Apertur can authenticate and write files.
5. Click Save to finish.

Azure Blob Storage

Deliver photos to an Azure Blob Storage container. Works well with Azure Functions, Logic Apps, and other Azure services.

1. Go to Project Settings > Destinations and add an Azure Blob destination.
2. Enter your storage account name, container name, and SAS token (or connection string).
3. Optionally configure a blob path template.
4. Test the connection to verify write access.
5. Click Save to finish.

// Example destination config (via API)
{
  "type": "azure_blob",
  "account_name": "mystorageaccount",
  "container_name": "photos",
  "sas_token": "sv=2023-01-03&st=...",
  "blob_template": "uploads/{session_id}/{image_index}.{ext}"
}

WebDAV

Deliver photos to any WebDAV-compatible server. Supports Nextcloud, ownCloud, and other WebDAV implementations.

1. Navigate to Project Settings > Destinations and add a WebDAV destination.
2. Enter the server URL, username, and password.
3. Specify the remote directory path.
4. Test the connection to ensure Apertur can write files.
5. Click Save to finish.

Make sure your WebDAV server supports the PUT method and that the target directory exists.

Testing Your Destination

Before using a destination in production, we recommend testing it with a sample session.

1. Create a session using a test API key.
2. Set max_images to 1 for a quick test.
3. Scan the QR code and upload a test photo.
4. Verify the photo arrived at your destination.