API Documentation
Authentication
The Tagembed Widget API provides powerful tools to programmatically access and manage your social media galleries, posts, and widgets. Build custom integrations, automate content workflows, and create dynamic social displays with our RESTful API.
What You Can Do
- Retrieve gallery information and metadata
- Fetch social media posts with pagination
- Create custom posts programmatically
- Integrate with your existing workflows
- Build custom social media displays
Popular Use Cases
- Website social media integration
- Custom dashboard development
- Automated content syndication
- Mobile app social feeds
- Analytics and reporting tools
user_key parameter.Authentication
Include your API user key as a query parameter in all requests. This key identifies your account and ensures secure access to your gallery data:
https://api.tagembed.com/api/v1/support/galleries?user_key=YOUR_USER_KEY
API Key Security Best Practices
- Store your API key securely using environment variables
- Never expose your API key in client-side code or public repositories
- Regenerate your key if you suspect it has been compromised
- Use server-side implementations for production applications
Response Formats
The API supports both JSON and XML response formats. Use the format parameter:
?format=json
?format=xml
Standard Response Structure
{
"responseCode": 200,
"responseStatus": "success",
"responseMessage": "Operation completed successfully",
"responseData": "/* API specific data */"
}GETGet Gallery Info
Retrieve comprehensive information about a specific gallery including gallery details, configuration settings, and all associated social media feeds. This endpoint provides essential metadata needed for gallery management and feed analysis.
https://api.tagembed.com/api/v1/support/galleries?user_key=${user_key}&format=${format}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_key | string | Required | Your API authentication key obtained from your Tagembed account settings. This key provides secure access to your gallery data. Example: 605b54dfbed1d7bdad7fce305e135a78 |
format | string | Optional | Response format preference. Choose 'json' for JavaScript applications or 'xml' for legacy systems. Defaults to JSON if not specified. Example: json/xml |
Code Example
Response Examples
GETGet Feed Info
Returns the feed sources for a specific gallery. You can filter using a user key and gallery Id for the list
https://api.tagembed.com/api/v1/support/feeds?user_key=${user_key}&galleryId=${galleryId}&format=${format}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_key | string | Required | Your API authentication key obtained from your Tagembed account settings. This key provides secure access to your gallery data. Example: 605b54dfbed1d7bdad7fce305e135a78 |
galleryId | integer | Required | The unique identifier for the gallery. You can find this Id in your Tagembed dashboard under gallery settings. Example: 2183925 |
format | string | Optional | Response format preference. Choose 'json' for JavaScript applications or 'xml' for legacy systems. Defaults to JSON if not specified. Example: json/xml |
Code Example
Response Examples
GETGet Post Info
Retrieves gallery posts with filters for network Id, user key, and gallery Id etc. You can also choose to show only tagged posts.
https://api.tagembed.com/api/v1/support/posts?user_key=${user_key}&galleryId=${galleryId}&format=${format}Parameters
| Parameter | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
user_key | string | Required | Your API authentication key obtained from your Tagembed account settings. This key provides secure access to your gallery data. Example: 605b54dfbed1d7bdad7fce305e135a78 | ||||||||||||||||||||||||||||||||||||||||||||||||||
galleryId | integer | Required | The unique identifier for the gallery. You can find this Id in your Tagembed dashboard under gallery settings. Example: 2183925 | ||||||||||||||||||||||||||||||||||||||||||||||||||
feedId | array | Optional | The unique identifier for the feed. Example: [2183925] | ||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer | Optional | The number of posts to retrieve. Defaults to 10 if not specified. Example: 10 | ||||||||||||||||||||||||||||||||||||||||||||||||||
offset | integer | Optional | The number of posts to skip before starting to retrieve. Defaults to 0 if not specified. | ||||||||||||||||||||||||||||||||||||||||||||||||||
networkId | array | Optional | The network Ids to filter posts by. Defaults to all networks if not specified. Example: Network Id List[4,2]
| ||||||||||||||||||||||||||||||||||||||||||||||||||
productId | string | Optional | The product Id to filter posts by. Defaults to all products if not specified. Example: 112-hst | ||||||||||||||||||||||||||||||||||||||||||||||||||
taggedOnly | boolean | Optional | If true, only posts that are tagged with the specified product will be returned. Defaults to false if not specified. Example: true/false | ||||||||||||||||||||||||||||||||||||||||||||||||||
format | string | Optional | Response format preference. Choose 'json' for JavaScript applications or 'xml' for legacy systems. Defaults to JSON if not specified. Example: json/xml |
Code Example
Response Examples
Error Codes
Understanding error codes helps you debug issues and handle edge cases gracefully. The Tagembed API returns standardized HTTP status codes with detailed error messages to help you identify and resolve problems quickly.
200HTTP Status Codes
Request was successful.
404Not Found
Request was not found.
400Bad Request
Invalid parameters or malformed request.
500Internal Server Error
Something went wrong on our end
Error Handling Best Practices
- Always check the responseCode field before processing data
- Implement retry logic for temporary server errors (5xx codes)
- Cache successful responses to reduce API calls
- Log errors with request parameters for debugging
- Display user-friendly error messages in your application
- Handle rate limiting gracefully with exponential backoff
401Unauthorized
Invalid or missing API key
{
"responseCode": 401,
"responseStatus": "error",
"responseMessage": "API is not available in this plan OR Wrong user key!"
}404Invalid Gallery Id
When the requested gallery doesn't exist or you don't have access
{
"responseCode": 404,
"responseStatus": "error",
"responseMessage": "Gallery not found or access denied"
}400Missing Required Parameters
Missing required parameters
{
"responseCode": 400,
"responseStatus": "error",
"responseMessage": "Missing required parameter: user_key!"
}
