Endpoint: | GET world.{FILE_TYPE} |
Resource URL: | http://www.mytravelmap.xyz/api/v1/world.{FILE_TYPE} |
FILE_TYPE: | json - generates JSON response with detailed textual information of the resulting image png - generates actual image in PNG format bmp - generates actual image in BMP format |
Name | Required | Description | Default value | Example |
---|---|---|---|---|
appKey | Yes | Application identifier | JKUmj2fjJMgOQs3Y | |
width | Yes | Image width (px) (max 2050) | 1024 | |
height | Yes | Image height (px) (max 2050) | 512 | |
bgColor | No | Image background color (sea). (either 6 hexadecimal RGB or 8 hexadecimal RGBA) |
ffffff | RGB - c0c0c0 RGBA - c0c0c099 |
fgColor | No | Image foreground color (land). (either 6 hexadecimal RGB or 8 hexadecimal RGBA) |
a9a9a9 | RGB - c0c0c0 RGBA - c0c0c099 |
dither | No | Intentionally applied form of noise. See Wikipedia - Dither | no | no yes |
geo | No (possible to use multiple times) | List of GPS coordinates colored with a specified color. At least one GPS coordinate (in the format lat,lon) has to be specified. Value format either 'rgb$lat,lon!...' or 'rgba$lat,lon!...' |
990000$50.361459,13.851300 990000$50.361459,13.851300!32.548774,35.857268 990000$50.361459,13.851300!32.548774,35.857268!3.113924,101.617261 cc7700aa$50.361459,13.851300 cc7700aa$50.361459,13.851300!32.548774,35.857268 cc7700aa$50.361459,13.851300!32.548774,35.857268!3.113924,101.617261 |
|
pin | No (possible to use multiple times) | List of GPS coordinates colored with a specified color. At least one GPS coordinate (in the format lat,lon) has to be specified. Value format either 'rgb$lat,lon!...' or 'rgba$lat,lon!...' The pins will always be placed in the middle of country which contains the GPS coordinate! |
990000$50.361459,13.851300 990000$50.361459,13.851300!32.548774,35.857268 990000$50.361459,13.851300!32.548774,35.857268!3.113924,101.617261 cc7700aa$50.361459,13.851300 cc7700aa$50.361459,13.851300!32.548774,35.857268 cc7700aa$50.361459,13.851300!32.548774,35.857268!3.113924,101.617261 |
|
pinScale | No | Size of the pin. This attribute will have an effect only when used together with pin attribute. |
0.3 | 0.75 |
pinLabelColor | No | Color of the label (country name) displayed above the pin. This attribute will have an effect only when used together with pinLabelSize attribute. (either 6 hexadecimal RGB or 8 hexadecimal RGBA) |
000000 | RGB - c0c0c0 RGBA - c0c0c099 |
pinLabelFont | No | Font family of the label (country name) displayed above the pin. This attribute will have an effect only when used together with pinLabelSize attribute. |
sans-serif | sans-serif, serif, Arial,... |
pinLabelLocale | No | Locale of the label (country name) displayed above the pin. This attribute will have an effect only when used together with pinLabelSize attribute. |
en | All supported locales: Albanian (sq), Amharic (am), Arabic (ar), Armenian (hy), Azerbaijani (az), Bangla (bn), Belarusian (be), Bulgarian (bg), Burmese (my), Catalan (ca), Chinese (zh-CN), Chinese (zh-TW), Croatian (hr), Czech (cs), Danish (da), Dutch (nl), English (en), Estonian (et), Filipino (fil), Finnish (fi), French (fr), Georgian (ka), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Indonesian (id), Italian (it), Japanese (ja), Kazakh (kk), Korean (ko), Lao (lo), Latvian (lv), Lithuanian (lt), Malay (ms), Mongolian (mn), Nepali (ne), Norwegian (no), Persian (fa), Polish (pl), Portuguese (pt-BR), Portuguese (pt-PT), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es), Swahili (sw), Swedish (sv), Tamil (ta), Thai (th), Turkish (tr), Ukrainian (uk), Urdu (ur), Uzbek (uz), Vietnamese (vi) |
pinLabelSize | No | Size of the label (country name) displayed above the pin. Unit is pt. All the other pinLabel* attributes will have effect only if this attribute is a positive integer. |
0 | 6 |
pinLabelWeight | No | Font weight of the label (country name) displayed above the pin. This attribute will have an effect only when used together with pinLabelSize attribute. |
normal | normal, bold |
userId | No | User ID in our system. | Each user can check their ID after logging in into our website and by clicking on "Permalink" on the left menu. A popup window will display the user's permalink. The last part of the permalink is the user's ID in our system. For example in the following permalink https://www.mytravelmap.xyz/u/fb10153329637423541 the fb10153329637423541 is the user's ID. |
|
userColorBorn | No | Color of the country the user was born in. (either 6 hexadecimal RGB or 8 hexadecimal RGBA) This parameter is only used when userId is specified as well. |
000000 | RGB - c0c0c0 RGBA - c0c0c099 |
userColorLived | No | Color of the country the user has lived in. (either 6 hexadecimal RGB or 8 hexadecimal RGBA) This parameter is only used when userId is specified as well. |
000000 | RGB - c0c0c0 RGBA - c0c0c099 |
userColorVisited | No | Color of the country the user has visited. (either 6 hexadecimal RGB or 8 hexadecimal RGBA) This parameter is only used when userId is specified as well. |
000000 | RGB - c0c0c0 RGBA - c0c0c099 |
sig | Yes (when using your app key) No (when using testing app key) |
Request signature which is created for security reasons | bf72dbe5fb6f588ff3df6fcb23587b220c204da3 |
$sign = '';
foreach ($sortedUrlParameters as $key => $value) {
if ($key != 'sig') {
$sign .= ($key.'='.$value);
}
}
$sign .= APP_SHARED_SECRET;
$sign = sha1($sign);
An example how to calculate the signature: