Platform API Access

The Platform API lets you automate tasks like marking entries as submitted after artists pay through your own payment system. This is useful if you handle payments outside of EntryThingy (for example, through your gallery's website).

Who Needs This?

Most galleries don't need the API. You only need it if:

• You have a custom payment system on your website
• You want to automatically mark entries as submitted after payment
• You have a developer who can integrate with APIs

If you use EntryThingy's built-in payment options (PayPal, Stripe, or fee-free submissions), you don't need the API.

Generating Your API Key

1. Log in as an administrator
2. Go to Preferences (under Tools in the navigation menu)
3. Click Advanced Settings at the bottom of the page
4. In the API Settings section, click Generate API Key
5. Confirm by clicking Generate Key in the popup
6. Important: Copy your API key immediately and save it somewhere secure. You won't be able to see it again.

Managing Your API Key

• Regenerate: Creates a new key and invalidates the old one. Any integrations using the old key will stop working immediately.
• Revoke: Removes your API key entirely. You can generate a new one later if needed.

For Developers

Full technical documentation is available at:

https://app.entrythingy.com/api/docs

This includes: - Authentication details (use your API key in the X-API-Key header) - Available endpoints for listing calls and updating entry status - Request/response formats - Code examples

Quick Start

To mark an entry as submitted after payment:

bash curl -X PATCH https://app.entrythingy.com/api/platform/entries/12345 \ -H "X-API-Key: your_api_key_here" \ -H "Content-Type: application/json" \ -d '{"status": "submitted"}'

Common Questions

What happens when I mark an entry as submitted via the API?

The same things that happen when an artist submits normally: - One token is deducted from your platform - The artist receives a confirmation email - The artwork is added to the artist's portfolio (if auto-populate is enabled)

Can I test the API without affecting real data?

We recommend creating a test call with test entries. The API works the same way regardless of which call you're using.

I lost my API key. What do I do?

Go to Preferences > Advanced Settings and click "Regenerate Key" to create a new one. Your old key will stop working immediately.

Who can see my API key?

Only administrators on your platform can access the API Settings section. The key is only shown once when generated, and we never store the actual key (only a secure hash for verification).