API Documentation

Welcome to the API documentation! This guide explains how to authenticate, interact with the API endpoints, and handle responses effectively. If you have any issues, feel free to reach out to our support team.

Authentication

To interact with the API, you'll need to obtain an API key.

Enroll for API Key

1. Ensure you are logged in, go to settings and click on the API tab.
2. Click on the "Generate key" button and enter a name for the key.
3. Copy the generated key and store it securely. The key will only be visible for 1 hour.

Revoke an API Key

1. Go to the API tab in settings.
2. Click on the "Revoke" button next to the key you want to revoke.

Making API Calls

Endpoint

Headers

Payload

Valid options include:

• Removal
• Modern bedroom
• Scandinavian bedroom
• ...

Response

Webhook Integration

Webhook Payload

Webhook Example

Security Best Practices

1. Signature Verification: Always validate the Verification-Token in your webhook.
2. Protect Your API Key: Never expose your raw API key publicly and rotate it periodically.
3. Request Validation: Verify the Authorization and Email headers.

Examples

Python

JavaScript

Ruby

cURL