Scenarios
How OCPL staff use the admin console day-to-day. Six scenarios cover the common tasks; the rest is exploration.
Share a file with a customer, vendor, or retailer
When you'd use this
You have a PDF, image, or other document already uploaded to OCPL S3 (invoices, purchase orders, scheme documents, product photos) and want to send a short, branded link to an external recipient.
Steps
- Open /admin/links/new.
- Fill in the file path (S3 key), MIME type, and an optional human-readable label that describes what the document is — Finance and Sales will use this to find the link months later.
- Add tags to make the link findable later — by region, by document type, by fiscal year, or by customer cohort.
- Click Create. Copy the
ez.fyi/...URL from the success screen. - Send it via WhatsApp, email, or SMS through your usual channel — recipients click straight through to the file with no login or signup.
Notes
- The recipient sees only the short URL — never the S3 path or any internal identifier. The URL bar stays on
ez.fyi/<slug>while the file streams. - Files up to 25 MB can be uploaded directly via the form; larger files must be placed in S3 first by IT.
Find an old link
When you'd use this
Someone asks "what was the link we sent to North Zone for the Q1 invoices?" six months later. You need to either resend it, or check whether it has been revoked.
Steps
- Open /admin/links.
- Use the free-text search box to filter by label or part of the file path.
- Combine with tag chips (e.g.
region:north+doc-type:invoice+fiscal-year:2025-26) to narrow results. - Click the slug to open the detail page — copy the URL or revoke from there.
Notes
- Tag filters are AND-semantic: every selected chip must be present on the link.
- The list shows the most recent
last_accessed_atper link, so you can tell at a glance whether the recipient has actually opened the file.
Revoke a link
When you'd use this
The file should no longer be accessible — wrong document was sent, the deal fell through, or the customer relationship ended.
Steps
- Open the link detail page from /admin/links.
- Scroll to the Danger zone section.
- Click Revoke this link and confirm.
Notes
- Recipients hitting a revoked link see a branded 410 Gone page — no error details, no fallback path. The S3 file itself is never deleted; revocation is a flag flip in the database.
- Only the link creator can revoke a link from the UI; admin users can revoke anything. If a webhook was registered with the link or with the API consumer that created it, a revoke notification fires fire-and-forget within seconds.
Replace a link's file (when the original was wrong)
When you'd use this
You sent the wrong document — wrong revision of an invoice, wrong product image, wrong PO. You want the recipient who has already received the URL to see the corrected file when they next click, without sending them a new link.
Steps
- Open the link detail page.
- Scroll to the File section in the Overview tab.
- Click Replace file, upload the corrected file (or paste a new S3 key for files already uploaded).
- Save.
Notes
- The URL stays exactly the same — same slug, same short link the recipient already has. The file behind it changes; on their next click they get the corrected version. This is one of ez.fyi's distinguishing capabilities versus ordinary URL shorteners.
- The replacement is logged in the link audit history, so you can always see who replaced what and when.
- If the recipient has already cached the old file in their browser, they may need to refresh. The Cache-Control on every response is
private, no-store, so this is rare.
Tag a link so others can find it
When you'd use this
You are creating or editing a link, and you want it findable later by yourself, your team, or whoever picks up the relationship next.
Steps
- On the create form or detail page, type a tag and press Enter to add it.
- Use the
namespace:valueconvention — e.g.region:north,doc-type:scheme,fiscal-year:2026-27,customer:zone-mumbai. - Add as many as are useful, up to 20 per link.
Notes
- Tags are case-insensitive on input —
Region:Northis stored asregion:north. They are free-form strings, deduped automatically. - The colon in
region:northis purely a display convention — render time splits the namespace for the UI; the storage form is a flat string. - Existing tags from previous links auto-suggest as you type, so the team converges on shared vocabulary without an enforced taxonomy.
Get an API key (for IT)
When you'd use this
An ERP, billing system, or customer-portal integration needs to create links programmatically — not through the admin UI — on a recurring basis.
Steps
- Open /admin/consumers/new.
- Give it a descriptive name (the integrator team and system).
- Optionally provide a default webhook URL to receive revoke notifications.
- Click Create. The plaintext key (
ezfy_...) is shown once. Copy it immediately and deliver it to the integrator over a secure channel. - Hand the integrator /docs/getting-started for the developer-side instructions.
Notes
- After the create dialog closes, only the SHA-256 hash of the key is stored. Lose it and you must rotate.
- Keys can be revoked from the consumer detail page; revocation is instant and a new key can be issued in the same minute.