YouMap Public API
Complete documentation for integrating with the YouMap platform
Complete documentation for integrating with the YouMap platform
YouMap Public API allows you to integrate with our mapping platform to create, manage, and interact with location-based content.
Include your API key in the X-API-Key header for all API requests:
curl -X GET "https://developer.youmap.com/api/v1/maps" \
-H "X-API-Key: ym_your_api_key_here" \
-H "Content-Type: application/json"const response = await fetch('https://developer.youmap.com/api/v1/maps', {
method: 'GET',
headers: {
'X-API-Key': 'ym_your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);https://developer.youmap.com/api/v1Direct access to API specification:
Sign in with your YouMap account to view, create, and manage your API keys.
Post Templates (also called "Actions" in the backend) are blueprints that define the structure and fields of posts that users can create on your maps. They act as customizable forms that determine what information users can input when creating posts.
A Post Template is like a form template - you define what fields users can fill out (text, images, ratings, etc.), and users create posts by filling out those fields.
Post Templates use a versioning system where:
version when updating templatesFeatured fields are special fields that appear prominently in the UI and have strict rules:
MINIMUM: At least 1 field must be featured
MAXIMUM: Only 3 fields can be featured per template
Featured fields appear in post previews. Every template needs at least one featured field.
Version must be specified when updating templates
Always include the version field in your update requests.
Only one date field allowed per template
Date fields have complex validation rules based on their type and duration settings.
Only predefined colors allowed
Templates must use one of the 22 predefined border colors from the allowed list.
Purpose: Single or multi-line text input
Properties:
label - Display name for the fieldplaceholder - Hint text for usersrequired - Whether field must be filledfeatured - Whether field appears in previewsorder - Display order within field typePurpose: Audio file uploads
Validation:
Purpose: URL links with different types
Properties:
linkType - Type of link (Default, Social, etc.)placeholder - Example URL formatPurpose: Dropdown or multi-select options
Critical Rules:
Purpose: 1-5 star ratings
Validation:
Purpose: Numeric range selection
Critical Rules:
Purpose: Predefined option selection via slider
Rules:
Purpose: Date/time selection with complex rules
Types:
Date - Date onlyTime - Time onlyDateAndTime - Both date and timeCritical Rules:
| Duration | Value | Description | Special Rules |
|---|---|---|---|
| Forever | 0 | Posts never expire | Default option |
| 1 Hour | 3600 | Posts expire after 1 hour | - |
| 1 Day | 86400 | Posts expire after 24 hours | - |
| 1 Week | 604800 | Posts expire after 7 days | - |
| BasedOnDateField | -1 | Posts expire based on date field | Requires date field with allowTimeRanges=true and required=true |
Templates must use one of these predefined border colors:
#8337EC
#E43AFF
#A86EFF
#87A2FB
#64DFDF
#FF006E
#FF63C1
#FF7D00
#FFAB00
#FFCB00
#C0E218
#00D880
#8DCCFC
#4EA6FD
#802AFF
#3E7C17
#29B23F
#1B939F
#342EAD
#8A9297
#4C5F68
#232932
{
"name": "Restaurant Review",
"fields": {
"textFields": [
{
"label": "Review Title",
"featured": true,
"order": 1
},
{
"label": "Additional Notes",
"featured": false,
"order": 4
}
],
"ratingFields": [
{
"label": "Overall Rating",
"featured": true,
"order": 2
}
],
"selectFields": [
{
"label": "Meal Type",
"featured": true,
"order": 3
}
]
}
}Creating a template with no featured fields will cause validation errors.
Solution: Ensure at least 1 field is marked as featured.
Setting more than 3 fields as featured will cause validation errors.
Solution: Limit featured fields to your 3 most important ones.
Using colors not in the predefined list causes validation errors.
Solution: Use only colors from the allowed border colors list.