Skip to content

Commit 959f345

Browse files
authored
docs: update url
1 parent cac49c4 commit 959f345

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

deeplink/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ It lets anyone craft a special URL that, when opened, guides the recipient throu
1111
```
1212
Link creator
1313
14-
│ https://vouchervault-linker.lrvt.de/create-item
14+
│ https://vouchervault-linker.lrvt.de/import
1515
│ #name=Foo&code=ABC123&type=giftcard
1616
│ └─── hash fragment (never sent to server) ───┘
1717
1818
Cloudflare Worker
1919
│ Serves a static HTML page.
20-
│ Worker request logs only see: GET /create-item (no sensitive data)
20+
│ Worker request logs only see: GET /import (no sensitive data)
2121
2222
Browser (client-side JS)
2323
│ Reads window.location.hash and parses it as URLSearchParams.
@@ -47,12 +47,12 @@ URL **fragments** (the `#...` part) are a browser-only concept. They are **never
4747

4848
The base URL is the public worker URL (e.g. `https://vouchervault-linker.lrvt.de`).
4949

50-
The path can be anything (e.g. `/create-item`) — the worker always redirects to `/items/create/` on the target instance regardless.
50+
The path can be anything (e.g. `/import`) — the worker always redirects to `/items/create/` on the target instance regardless.
5151

5252
All voucher data goes into the **hash fragment** as URL-encoded query parameters:
5353

5454
```
55-
https://vouchervault-linker.lrvt.de/create-item#<param>=<value>&<param>=<value>
55+
https://vouchervault-linker.lrvt.de/import#<param>=<value>&<param>=<value>
5656
```
5757

5858
### Supported parameters
@@ -79,13 +79,13 @@ These map directly to the VoucherVault create-item form fields:
7979

8080
Minimal — just a gift card code:
8181
```
82-
https://vouchervault-linker.lrvt.de/create-item#name=Amazon&type=giftcard&code=ABC-1234-XYZ
82+
https://vouchervault-linker.lrvt.de/import#name=Amazon&type=giftcard&code=ABC-1234-XYZ
8383
```
8484
This will redirect to: `https://myvault.example.com/items/create/?name=Amazon&type=giftcard&code=ABC-1234-XYZ`
8585

8686
Full example:
8787
```
88-
https://vouchervault-linker.lrvt.de/create-item#name=Amazon+Gift+Card&issuer=Amazon&type=giftcard&code=ABC-1234-XYZ&code_type=qrcode&value=25&description=Giftcard%20from%20grandma%20for%20my%2018th%20birthday&expiry_date=2026-12-31&logo_slug=amazon.com&pin=12345&tile_color=%234154f1
88+
https://vouchervault-linker.lrvt.de/import#name=Amazon+Gift+Card&issuer=Amazon&type=giftcard&code=ABC-1234-XYZ&code_type=qrcode&value=25&description=Giftcard%20from%20grandma%20for%20my%2018th%20birthday&expiry_date=2026-12-31&logo_slug=amazon.com&pin=12345&tile_color=%234154f1
8989
```
9090

9191
> **Note:** URL-encode special characters in values. Spaces can be `+` or `%20`. The `#` character in a hex colour must be encoded as `%23`.

0 commit comments

Comments
 (0)