Introduction
The Get Cliparts API is designed to retrieve a collection of clipart assets available within the system for product personalization and design customization workflows. This API enables applications to fetch clipart resources that can be used by end users while creating or editing customized products, ensuring a rich and interactive design experience.
The API provides detailed information about each clipart item, including metadata such as clipart identifiers, categories, file paths, preview images, supported formats, and other configuration details required for rendering and managing clipart assets efficiently within the customization interface.
Typically, this API is invoked during the product design process when the application needs to display available clipart libraries, allow users to browse and search graphical assets, or dynamically load clipart elements into the design editor. It supports seamless integration with product customization platforms and helps maintain a consistent and scalable asset management workflow.
UseCases
- Fetch Cliparts by Clipart family
Retrieve cliparts stored within a specific Clipart Family using the folderCode.
Useful for displaying categorized clipart libraries (e.g., icons, shapes, festive elements).
- Rule-Based Clipart Filtering
Use the ruleCode parameter to fetch cliparts that meet certain predefined rules or conditions.
Helps enforce business logic such as user permissions or product-specific restrictions.
- Search Cliparts by Keyword
Leverage the searchKey parameter to allow users to search cliparts by name or related terms.
Ideal for improving user experience in large libraries.
- Pagination for Large Data Sets
Control the number of records returned using pageSize and navigate through results using pageIndex.
Ensures optimized performance and faster loading times in UI applications.
- Dynamic Clipart Loading in Customization Tools
Fetch cliparts dynamically when users open a design tool or switch categories.
Supports real-time customization workflows in web-to-print or design applications.
- Admin or CMS Integration
Enable backend systems or admin panels to fetch and manage clipart's efficiently for monitoring and organization.
API Details
Endpoint
GET /api/4/ Cliparts/GetCliparts
curl --location 'https://api.artifi.net/api/4/Cliparts/GetCliparts?folderCode=foldercode&clientCode=clientcode&ruleCode=rulecode&pageSize=25&pageIndex=1&searchKey=Flower' \\
--header 'websiteId: 23' \\
--header 'webApiClientKey: c961461a-bQWA287-448c-b9ea-e1162bd2f0b8h'
Parameters
Header validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Default | Description |
FolderCode | string | No | — | This parameter refers to a specific folder within the Artifi system that organizes and categorizes cliparts, templates, or other customizable assets. It helps in structuring content for easier retrieval and management. If provided, the API will filter the data based on the specified folder.
|
RuleCode | String | No | —
| This parameter refers to the clipart family folder where cliparts are categorized based on predefined rules. Each RuleCode represents a specific category of cliparts, allowing users to fetch data at the rule level. When making an API request, specifying the RuleCode ensures that only the cliparts under that particular category are retrieved.
|
pageSize | integer | YES | 25 | This is an optional parameter, if no value is passed then the user will get all the customized product data collection in the ascending order. If PageIndex and PageSize are passed then only the related list would load.
|
pageIndex | Integer | YES | 1 | This is an optional parameter, if no value is passed then the user would get all the customized product data collection in the ascending order. If PageIndex and PageSize are passed then only the related list would load. |
searchKey | string | Yes |
|
This parameter refers to the keyword used to filter the results based on specific product attributes. If provided, only user photos matching the search key will be retrieved. |
Success Responses
{
"Response": "Success",
"Message": "",
"Data": {
"ClipartFamilyList": [
{
"Id": 80,
"Name": "Chocolates",
"DisplayName": null,
"DisplayOrder": 0,
"Code": "80",
"ImageUniqueName": null
}
],
"ClipartList": {
"FamilyId": 80,
"AssetCount": 1,
"AssetList": [
{
"Id": 899,
"UniqueName": "215dda16-29e2-49c6-8fcf-b2cd631ea333.png",
"ImageName": "letter_1",
"Width": 224,
"Height": 224,
"Code": "899",
"IsPrintImagePresent": false,
"PrintImageUniqueName": null,
"IsVector": false,
"VectorImageUniqueName": null,
"DisplayImageUniqueName": null,
"DisplayOrder": 0,
"EmbStitchCount": 0,
"EmbColorCount": 0,
"ThreadList": [],
"RenderingTypeId": 1
}
]
}
},
"ErrorCode": ""
}
Error Code List (Click Here)
Q&A
1. What is the purpose of the Get Cliparts API?
The Get Cliparts API is used to retrieve clipart assets available in the system for product customization and design workflows. It helps applications display and manage clipart libraries dynamically.
2. Which parameters are mandatory?
The following parameters are required:
- folderCode
- ruleCode
- clientCode
- Authentication headers (websiteId, webApiClientKey) in V4
3. What does folderCode represent?
folderCode refers to a specific folder in the system that organizes cliparts or assets. It is used to fetch cliparts from a particular category or collection.
4. What is the use of ruleCode?
ruleCode is used to filter cliparts based on predefined business rules or categories. It ensures only relevant cliparts are returned.
6. How does pagination work in this API?
Pagination is controlled using:
- pageSize: Number of records per page (default: 25)
- pageIndex: Page number (default: 1)
If not provided, all records may be returned in ascending order.
7. Can I search for specific cliparts?
Yes, you can use the searchKey parameter to filter cliparts based on keywords such as name or related terms.
8. What happens if no data is found?
If no cliparts match the provided criteria, the API will return a success response with an empty ClipartList.
9. Is authentication required for this API?
Yes, authentication is mandatory:
- In API, it must be included in request headers.
10. What kind of data does the API return?
The API returns:
Clipart families (categories)
Clipart asset details such as:
- ID, name, dimensions
- Image paths
- Rendering type
- Vector/print availability
- ID, name, dimensions
- Image paths
- Rendering type
- Vector/print availability
11. Can this API be used in real-time applications?
Yes, it is designed for real-time use cases such as loading cliparts dynamically in design tools or customization interfaces.
12. How can errors be handled?
Errors are returned using:
- Response
- Message
- ErrorCode
Refer to the Error Code (Click Here) documentation for detailed handling.