AVDEB for Developers
The code behind our free tools, released as small open-source packages — plus a WordPress plugin and a public product feed foraffiliates andcreators.
Open-source packages
Our first MIT-licensed packages for JavaScript, PHP and Python are on the way — STL parsing and 3D print cost estimation first. They'll be listed here as soon as they're published.
WordPress plugin: AVDEB Product Embeds
Show AVDEB products on your WordPress site as a block or shortcode. Creators can embed their own shop; affiliates paste their secret API key (or just a referral code) once and every product link carries it. Product links are marked rel="sponsored" when a referral code is set, and the plugin can add an affiliate disclosure for you.
Coming soon to the WordPress.org plugin directory.
Shortcodes
[avdeb_products creator="your-creator-slug" limit="6" columns="3"]A grid of one creator's products — for creators showing their AVDEB shop on their own site.
[avdeb_products tag="stickers" limit="8"]Products from a category (the slug in /category/…/).
[avdeb_product handle="product-handle"]One product card (the handle is the last part of the product URL).
[avdeb_link url="/store/product-handle/"]Get yours[/avdeb_link]A text link to any avdeb.com page, with your referral code added.
Settings → AVDEB: your secret API key or referral code, cache time, default columns and the disclosure text.
Embed products on any website
Not on WordPress? Paste two lines into any page. Create a publishable key for your domain under Partner dashboard → Embeds & API — the dashboard builds the snippet for you. Products render in an isolated box that inherits your fonts; no cookies, no iframes, no tracking.
<div data-avdeb-products data-key="avdeb_pk_…" data-creator="your-creator-slug" data-limit="6"></div> <script src="https://avdeb.com/embed/v1.js" async></script>
Use one of data-creator, data-tag, data-handle or data-q, plus data-limit (up to 24), data-columns and data-disclosure. Anything inside the div stays visible until the products load.
Catalog API
Query products as JSON. Responses can be cached for 5 minutes; please cache them rather than calling on every page view.
GET https://api.avdeb.com/v1/catalog/products?creator=your-slug&limit=6| Access | How | Limit | Product links carry |
|---|---|---|---|
| No key | — | 12 per request, no paging | Your ?ref= code if you pass one |
| Publishable key | ?key=avdeb_pk_… from your allowed domains | 24 per request | Your referral code, automatically |
| Secret key | Authorization: Bearer avdeb_sk_… (server only) | 48 per request, cursor paging | Your referral code, automatically |
Parameters
- creator
- Creator slug (/creators/{slug}/)
- tag
- Category slug (/category/{slug}/)
- handle
- One product (/store/{handle}/)
- type
- Product type, e.g. Sticker
- q
- Search text (ranked, no paging)
- limit
- Number of products (default 6, capped per tier)
- cursor
- next_cursor from the previous page (secret keys)
- ref
- Referral code to add to links (without a key)
Response fields
- id, handle, title
- Product ID, URL slug and title
- url
- Product page, with the referral code when one applies
- image
- Medium-size image URL, or null
- price / compare_at_price
- Lowest current price and, when on sale, the previous price
- currency
- ISO 4217 code, e.g. USD
- type, tags
- Product type and category slugs
- creator
- { slug, name, url } for creator-designed products, otherwise null
- next_cursor
- Pass as cursor for the next page (secret keys), or null
Affiliate and creator links
Add your referral code to any avdeb.com URL. It works on product, category, creator and tool pages.
https://avdeb.com/store/product-handle/?ref=YOUR_CODENot a partner yet? Join the affiliate programor sell your designs as a creator.
Developer FAQ
Do I need an API key?
No. Without a key you can show up to 12 products per request and add your own ?ref= code. Active affiliates and creators can create keys under Partner dashboard → Embeds & API: a publishable key for the JavaScript embed, or a secret key for the WordPress plugin and servers. Keys add your referral code automatically and raise the limits.
What's the difference between a publishable and a secret key?
A publishable key (avdeb_pk_…) is meant to sit in your page's HTML and only works on the domains you list. A secret key (avdeb_sk_…) must stay on your server — for example in the WordPress plugin settings. Never put a secret key in HTML, JavaScript or a URL; if you do, revoke it.
Can I use the product data?
Yes, to show and link to AVDEB products. It's the same public information as our product pages. Please cache responses and don't copy product photos or descriptions to sell elsewhere.
How does affiliate attribution work?
Add ?ref=YOUR_CODE to any avdeb.com link. When a visitor arrives with the code, a 30-day first-party cookie records the referral, and qualifying orders earn commission. Your code is in the affiliate dashboard.
Does the WordPress plugin track my visitors?
No. The plugin requests products from your server, caches them, and renders plain links and images. The JavaScript embed loads product data in the visitor's browser. Neither sets cookies or sends visitor data; a referral is only recorded on avdeb.com when a visitor clicks a product.
Can I contribute to the open-source packages?
Yes — each package links to its GitHub repository, where issues and pull requests are welcome.