Contents |
URL
https://api.geoloqi.com/1/link/create
Description
Create a sharing link, which will grant anybody with this token access to the user's location for the specified time period.
Supported Request Methods
POST
Scope
share
Parameters
Note: If no date or times are specified, then the token will never expire. You can set any combination of date and time parameters, except if you specify a time_from, then you must also specify a time_to. You can also specify only a minutes parameter and the token will be valid from now for that many minutes.
- minutes OptionalThe link will be valid from the current time for the specified number of minutes. No other time parameters may be specified if this is included.
- date_from OptionalThe link will be valid only after this date and time
- date_to OptionalThe link will be invalid after this date and time
- time_from OptionalThe link will be valid only after this time (of every day)
- time_to OptionalThe link will be invalid after this time (of every day)
- description OptionalThe text that the user entered when creating this link. This will be displayed on the web page when viewing the link
- share_with OptionalA comma-separated list of email addresses or phone numbers to send the link to. If present, an email or SMS will be sent to everyone in the list.
Response
Success
If the shared link was created successfully, you will get a response like the following. The token will always be a 7-character string.
HTTP/1.1 200 OK { "link":"http://geoloqi.com/aaronpk/Cf9Krwu", "shortlink":"http://loqi.me/Cf9Krwu" "token":"Cf9Krwu" }