ホーム エクスプローラ ヘルプ
サインイン
mrkad
/
php-qrcode
同期ミラー https://github.com/chillerlan/php-qrcode.git
1
0
フォーク 0
ファイル 課題 0 Wiki
ツリー: 31f6a46f75
ブランチ タグ
php-qrcode
/
_sources
/
Appendix
/
URI-Content.md.txt

URI-Content.md.txt 15 KB
履歴 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270 
  1. # Popular content and URI schemes
    2. 

  2. 

  3. **A brief summary of popular use cases for QR codes.**
    4. 

  4. 

  5. 

  6. ## URL `https`
    7. 

  7. 

  8. Perhaps the most common use for QR Codes is to share URLs: simply encode the (URL-encoded) string value
    9. 

  9. and make sure to include the scheme `http(s)://` so that it can be properly identified by the reader application:
    10. 

  10. 

  11. ```
    12. 

  12. https://en.m.wikipedia.org/wiki/URL
    13. 

  13. ```
    14. 

  14. 

  15. Some URLs may open a vendor specific application, for example the following URL may open the YouTube app:
    16. 

  16. 

  17. ```
    18. 

  18. https://www.youtube.com/watch?v=dQw4w9WgXcQ
    19. 

  19. ```
    20. 

  20. 

  21. **See also:**
    22. 

  22. 

  23. - [What is a URL? (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL)
    24. 

  24. - [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)
    25. 

  25. 

  26. 

  27. ## E-Mail `mailto`
    28. 

  28. 

  29. E-Mail links are encoded similar to URLs, preceded by the `mailto:` scheme to ensure they are properly identified and the default mail application can be opened.
    30. 

  30. Parameters may be added as a [URL query string](https://en.wikipedia.org/wiki/Query_string):
    31. 

  31. ```
    32. 

  32. mailto:<ADDR>[,...?to=<ADDR>,...&cc=<ADDR>,...&bcc=<ADDR>,...&subject=<SUBJECT>&body=<BODY>]
    33. 

  33. ```
    34. 

  34. 

  35. | Query parameter | Description                                                                                                                                  |
    36. 

  36. |-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|
    37. 

  37. | `to`            | Alternative to add a recipient address: `mailto:<ADDR>?to=<ADDR>` is equivalent to<br/>`mailto:<ADDR>,<ADDR>` and `mailto:?to=<ADDR>,<ADDR>` |
    38. 

  38. | `subject`       | Subject text: `mailto:<ADDR>?subject=Hello%20World%21` would open the e-mail app<br/>and create a messagewith the subject `Hello World!`     |
    39. 

  39. | `body`          | Message body: `mailto:<ADDR>?body=This%20is%20the%20message%20body.`<br/>creates a message with the contents `This is the message body.`     |
    40. 

  40. | `cc`            | "Carbon copy" to add one or more `cc` recipients                                                                                             |
    41. 

  41. | `bcc`           | "Blind carbon copy" to add one or more `bcc` recipients                                                                                      |
    42. 

  42. 

  43. The fields for recipient adresses (`mailto:`, `to`, `cc`, `bcc`) may contain one or more elements separated by a comma `,`; the values of all fields shall be URL-encoded according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986).
    44. 

  44. 

  45. **Examples:**
    46. 

  46. 

  47. - `mailto:?to=addr1@example.com`
    48. 

  48. - `mailto:addr1@example.com,addr2@example.com`
    49. 

  49. - `mailto:addr1@example.com?cc=addr2@example.com&subject=Hello%21`
    50. 

  50. 

  51. **See also:**
    52. 

  52. 

  53.   - [RFC 6068 - The 'mailto' URI Scheme](https://datatracker.ietf.org/doc/html/rfc6068)
    54. 

  54.   - [Email links (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Creating_hyperlinks#email_links)
    55. 

  55.   - [Email (Wikipedia)](https://en.wikipedia.org/wiki/Email)
    56. 

  56.   - [mailto (Wikipedia)](https://en.wikipedia.org/wiki/Mailto)
    57. 

  57. 

  58. 

  59. ## Phone numbers `tel`
    60. 

  60. 

  61. A phone number should be prefixed with the `tel:` scheme so that a device's dialer can be invoked properly:
    62. 

  62. 

  63. ```
    64. 

  64. tel:+999-123-456-7890
    65. 

  65. ```
    66. 

  66. 

  67. Generally, the most complete version of a telephone number possible should be used, e.g. `+<country code><area code><number>`, spaces or hyphens may be used to separate blocks.
    68. 

  68. Some devices may also support the `sms` and `fax` schemes, which are deprecated in favor of `tel`.
    69. 

  69. 

  70. **See also:**
    71. 

  71. 

  72.   - [RFC 3966 - The 'tel' URI for Telephone Numbers](https://datatracker.ietf.org/doc/html/rfc3966)
    73. 

  73.   - [List of country calling codes (Wikipedia)](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
    74. 

  74.   - [National conventions for writing telephone numbers (Wikipedia)](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers)
    75. 

  75.   - [google/libphonenumber (GitHub)](https://github.com/google/libphonenumber) ([PHP port (GitHub)](https://github.com/giggsey/libphonenumber-for-php))
    76. 

  76. 

  77. 

  78. ## Geo Coordinates `geo`
    79. 

  79. 

  80. A geographical coordinate, including altitude can be encoded using the `geo:` URI scheme so that it can be opened with a map application.
    81. 

  81. 

  82. ```
    83. 

  83. geo:<latitude>,<longitude>[,<altitude>;crs=<crs>;u=<num>]
    84. 

  84. ```
    85. 

  85. 

  86. The default coordinate system is WGS-84, for which latitude and longitude should be supplied as decimal degrees, the optional altitude in meters.
    87. 

  87. The parameter `u` can be used to specify an *uncertainty* value (in meters), a different *coordinate reference system* may be supplied with `crs`.
    88. 

  88. 

  89. Some applications support an additional query string with values of `z` for *zoom* level and `q` for a local search *query* (URL-encoded):
    90. 

  90. ```
    91. 

  91. geo:<latitude>,<longitude>?z=<zoom>&q=<search>
    92. 

  92. ```
    93. 

  93. 

  94. **Examples:**
    95. 

  95. 

  96. - `geo:47.620521,-122.349293`
    97. 

  97. - `geo:27.988056,86.925278,8848`
    98. 

  98. - `geo:11.373333,142.591667,-10920;u=10`
    99. 

  99. - `geo:37.786971,-122.399677;crs=Moon-2011;u=35`
    100. 

  100. 

  101. **See also:**
    102. 

  102. 

  103. - [RFC 5870 - A Uniform Resource Identifier for Geographic Locations ('geo' URI)](https://datatracker.ietf.org/doc/html/rfc5870)
    104. 

  104. - [geo URI scheme (Wikipedia)](https://en.wikipedia.org/wiki/Geo_URI_scheme)
    105. 

  105. - [Coordinate reference system (Wikipedia)](https://en.wikipedia.org/wiki/Coordinate_reference_system)
    106. 

  106. 

  107. 

  108. ## Mobile Authenticators `otpauth`
    109. 

  109. 

  110. Mobile authenticators can be added with the `otpauth` scheme:
    111. 

  111. 

  112. ```
    113. 

  113. otpauth://<MODE>/<LABEL>?secret=<SECRET>[&issuer=<ISSUER>&params...]
    114. 

  114. ```
    115. 

  115. 

  116. The path elemets `MODE` and `LABEL` as well as the query parameter `secret` are mandatory, other query parameters are optional,
    117. 

  117. however, it is strongy advised to add the `issuer` parameter to ease identification.
    118. 

  118. The `LABEL`, as well as the `issuer` values shall be URL-encoded according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986).
    119. 

  119. 

  120. | Path element | Description                                                                                                                                                   |
    121. 

  121. |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
    122. 

  122. | `MODE`       | Authenticator mode, either `totp` (time based) or `hotp` (counter based)                                                                                      |
    123. 

  123. | `LABEL`      | The label is used to identify which account a key is associated with.<br/>It may be prefixed with the issuer name, separated by a colon: `<issuer>:<account>` |
    124. 

  124. 

  125. 

  126. | Query parameter | Description                                                                                                                                                                                                                                                 |
    127. 

  127. |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    128. 

  128. | `secret`        | Secret key (required), a cryptographically secure random string, encoded in Base32<br/>according to [RFC 3548](https://datatracker.ietf.org/doc/html/rfc3548) (without padding).<br/>Some authenticators may support Base64 and hexadecimal values as well. |
    129. 

  129. | `issuer`        | A string value indicating the provider or service this account is associated with.                                                                                                                                                                          |
    130. 

  130. | `algorithm`     | Hash algorithm, may be one of `SHA1` (default), `SHA256` or `SHA512`                                                                                                                                                                                        |
    131. 

  131. | `digits`        | Length of the OTP code: `6` or `8`                                                                                                                                                                                                                          |
    132. 

  132. | `counter`       | (`hotp` only, required) The initial counter value                                                                                                                                                                                                           |
    133. 

  133. | `period`        | (`totp` only) The period of time in seconds a code will be valid for (default: 30)                                                                                                                                                                          |
    134. 

  134. 

  135. The parameters `algorithm`, `digits` and `period` may not be supported by some devices/apps.
    136. 

  136. 

  137. **Examples:**
    138. 

  138. 

  139. - `otpauth://hotp/example.com:counter-based?secret=JBSWY3DPEHPK3PXP&counter=42`
    140. 

  140. - `otpauth://hotp/counter-based?secret=JBSWY3DPEHPK3PXP&issuer=example.com&digits=6&algorithm=SHA256&counter=42`
    141. 

  141. - `otpauth://totp/example.com%3Atime-based?secret=JBSWY3DPEHPK3PXP`
    142. 

  142. - `otpauth://totp/time-based?secret=JBSWY3DPEHPK3PXP&issuer=example.com&digits=8&algorithm=SHA512&period=60`
    143. 

  143. 

  144. **See also:**
    145. 

  145. 

  146. - [RFC 4226 - An HMAC-Based One-Time Password Algorithm](https://datatracker.ietf.org/doc/html/rfc4226)
    147. 

  147. - [RFC 6238 - Time-Based One-Time Password Algorithm](https://datatracker.ietf.org/doc/html/rfc6238)
    148. 

  148. - [Google Authenticator (Wikipedia)](https://en.wikipedia.org/wiki/Google_Authenticator)
    149. 

  149. - [google-authenticator: Key Uri Format (GitHub)](https://github.com/google/google-authenticator/wiki/Key-Uri-Format)
    150. 

  150. - [php-qrcode: Authenticator example (GitHub)](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php)
    151. 

  151. 

  152. 

  153. ## Wireless Network configuration
    154. 

  154. 

  155. Wi-Fi configuration general syntax looks as follows:
    156. 

  156. 

  157. ```
    158. 

  158. WIFI:S:<SSID>[;T:<TYPE>;P:<PASSWORD>;H:<HIDDEN>;];
    159. 

  159. ```
    160. 

  160. 

  161. | Parameter       | Description                                                                                                                            |
    162. 

  162. |-----------------|----------------------------------------------------------------------------------------------------------------------------------------|
    163. 

  163. | `S`<sup>*</sup> | Network SSID (required)                                                                                                                |
    164. 

  164. | `T`             | Authentication type: can be one of `WEP`, `WPA`, `WPA2-EAP`<br/>or `nopass` for no password (in which case you can omit the parameter) |
    165. 

  165. | `P`<sup>*</sup> | Password, ignored if parameter `T` is set to `nopass`                                                                                  |
    166. 

  166. | `H`             | Set to `true` the network SSID is hidden.                                                                                              |
    167. 

  167. 

  168. <sup>*</sup> the value shall be enclosed in double quotes `"` if it is an ASCII string that can be interpreted as hex, e.g. `"ABCD1234"`,
    169. 

  169. special characters `\ ; , " :` shall be escaped with a backslash `\`.
    170. 

  170. 

  171. Additional parameters for WPA2 and WPA3 (please note that these parameters may not be supported by some devices):
    172. 

  172. 

  173. | Parameter | Description                                                                                                                      |
    174. 

  174. |-----------|----------------------------------------------------------------------------------------------------------------------------------|
    175. 

  175. | `A`       | WPA2-EAP: Anonymous identity                                                                                                     |
    176. 

  176. | `E`       | WPA2-EAP: EAP method, like `TTLS` or `PWD`                                                                                       |
    177. 

  177. | `PH2`     | WPA2-EAP: Phase 2 method, like `MSCHAPV2`                                                                                        |
    178. 

  178. | `I`       | WPA2-EAP, WPA3: UTF-8 encoded password identifier, present if<br/>the password has an SAE password identifier                    |
    179. 

  179. | `K`       | WPA3: DER of ASN.1 SubjectPublicKeyInfo in compressed form<br/>and encoded in “base64”, present when the network supports SAE-PK |
    180. 

  180. | `R`       | WPA3: Transition Disable value                                                                                                   |
    181. 

  181. 

  182. **Examples:**
    183. 

  183. 

  184. - `WIFI:S:MyNetworkWihoutPassword;;`
    185. 

  185. - `WIFI:S:MyNetworkWihoutPassword;T:nopass;P:;;`
    186. 

  186. - `WIFI:S:MyHiddenWpaNetwork;T:WPA;P:"PASSWORD123";H:true;;`
    187. 

  187. - `WIFI:S:MyHiddenWpa2Network;T:WPA2-EAP;P:"PASSWORD123";H:true;;`
    188. 

  188. 

  189. **See also:**
    190. 

  190. 

  191. - [WPA3 Specification, Section 7.1](https://www.wi-fi.org/download.php?file=/sites/default/files/private/WPA3%20Specification%20v3.1.pdf)
    192. 

  192. - [Wi-Fi Protected Access (Wikipedia)](https://en.wikipedia.org/wiki/Wi-Fi_Protected_Access)
    193. 

  193. 

  194. 

  195. ## Contact information: vCard
    196. 

  196. 

  197. The vCard is the most commonly used format to exchange contact details. It's too complex to fully explain here, instead just a bare minimum example:
    198. 

  198. 

  199. ```
    200. 

  200. BEGIN:VCARD
    201. 

  201. VERSION:4.0
    202. 

  202. N:<NAME>
    203. 

  203. FN:<FULL NAME>
    204. 

  204. GENDER:O
    205. 

  205. EMAIL;type=(WORK|HOME):<EMAIL>
    206. 

  206. TEL;type=(WORK|CELL|HOME):<PHONE>
    207. 

  207. ADR;type=WORK:<LINE1>;<LINE2>;<STREET>;<CITY>;<STATE>;<ZIP>;<COUNTRY>
    208. 

  208. TZ:<CITY/COUNTRY>
    209. 

  209. URL:<URL>
    210. 

  210. PHOTO;JPEG:<LINK>
    211. 

  211. LOGO;JPEG:<LINK>
    212. 

  212. NOTE:<TEXT>
    213. 

  213. CATEGORIES:<LIST>
    214. 

  214. END:VCARD
    215. 

  215. ```
    216. 

  216. 

  217. **See also:**
    218. 

  218. 

  219. - [RFC 6350 - vCard Format Specification](https://datatracker.ietf.org/doc/html/rfc6350)
    220. 

  220. - [vCard (Wikipedia)](https://en.wikipedia.org/wiki/VCard)
    221. 

  221. - [vCard Ontology - for describing People and Organizations (W3C)](https://www.w3.org/TR/vcard-rdf/)
    222. 

  222. - [vobject library for PHP (GitHub)](https://github.com/sabre-io/vobject)
    223. 

  223. 

  224. 

  225. ## Calendar Events: vCalendar and iCalendar
    226. 

  226. 

  227. Calendar events can be shared via the iCalendar (formerly vCalendar) object (example from [icalendar-generator](https://github.com/spatie/icalendar-generator)):
    228. 

  228. 

  229. ```
    230. 

  230. BEGIN:VCALENDAR
    231. 

  231. VERSION:2.0
    232. 

  232. PRODID:spatie/icalendar-generator
    233. 

  233. NAME:Laracon online
    234. 

  234. X-WR-CALNAME:Laracon online
    235. 

  235. BEGIN:VEVENT
    236. 

  236. UID:5ef5c3f64cb2c
    237. 

  237. DTSTAMP;TZID=UTC:20200626T094630
    238. 

  238. SUMMARY:Creating calendar feeds
    239. 

  239. DTSTART:20190306T150000Z
    240. 

  240. DTEND:20190306T160000Z
    241. 

  241. DTSTAMP:20190419T135034Z
    242. 

  242. END:VEVENT
    243. 

  243. END:VCALENDAR
    244. 

  244. ```
    245. 

  245. 

  246. **See also:**
    247. 

  247. 

  248. - [RFC 5545 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)](https://datatracker.ietf.org/doc/html/rfc5545)
    249. 

  249. - [iCalendar (Wikipedia)](https://en.wikipedia.org/wiki/ICalendar)
    250. 

  250. - [vobject library for PHP (GitHub)](https://github.com/sabre-io/vobject)
    251. 

  251. - [iCalendar generator for PHP (GitHub)](https://github.com/spatie/icalendar-generator)
    252. 

  252. 

  253. 

  254. ## Credit Transfer
    255. 

  255. 

  256. ### SEPA (European Payments Council)
    257. 

  257. - [Guidelines to Enable the Data Capture for the Initiation of a SEPA Credit Transfer](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/quick-response-code-guidelines-enable-data-capture-initiation)
    258. 

  258. - [sepa-qr-data library for PHP (GitHub)](https://github.com/smhg/sepa-qr-data-php)
    259. 

  259. 

  260. ### Pix (Banco Central do Brasil)
    261. 

  261. - [Manual de Padrões para Iniciação do Pix (PDF)](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/II_ManualdePadroesparaIniciacaodoPix.pdf)
    262. 

  262. - [OpenBoleto (GitHub)](https://github.com/openboleto/openboleto)
    263. 

  263. 

  264. 

  265. ## See also
    266. 

  266. 

  267. - [RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax](https://datatracker.ietf.org/doc/html/rfc3986)
    268. 

  268. - [Uniform Resource Identifier (Wikipedia)](https://en.m.wikipedia.org/wiki/Uniform_Resource_Identifier)
    269. 

  269. - [List of URI schemes (Wikipedia)](https://en.m.wikipedia.org/wiki/List_of_URI_schemes)
    270. 

  270. - [zxing: Barcode Contents (GitHub)](https://github.com/zxing/zxing/wiki/Barcode-Contents)
    271.