SharinPix Fair Use Policy
Purpose
This Fair Use Policy (the “Policy”) outlines the acceptable usage terms for SharinPix’s image management solution, which operates on the Salesforce CRM platform and is distributed through the Salesforce AppExchange. This Policy aims to ensure that all clients can utilize SharinPix services fairly, securely, and efficiently while preventing service disruptions caused by excessive API usage.
Scope
This Policy applies to all organizations and users who interact with SharinPix services, including those accessing SharinPix through the managed package and the SharinPix mobile application. By using SharinPix services, clients agree to the terms outlined in this document, which are designed to safeguard system integrity and availability for all users.
API Usage and Rate Limits
SharinPix operates with an API rate-limiting system to ensure equitable resource access. API calls are made when users interact with any SharinPix resource.
API limits are an industry-standard practice to ensure that no single client monopolizes resources, thus maintaining all users' integrity and performance of SharinPix services. Limits are also designed to protect clients from service degradation caused by other clients overconsuming resources.
Additionally, rate limits function as a security standard, as unusually high API usage can often signal a potential data breach or unauthorized access. This allows for timely intervention to protect client data and maintain platform security.
API Call Usage
API call usage is calculated based on an organization’s API activity over 24 hours (a day). API calls are made when users visually interact with SharinPix components or use code (libraries, plugins or scripts) to communicate with SharinPix servers. Examples of interactions include but are not limited to:
- Loading image thumbnails and viewing images
- Tagging, ordering and annotating images
- Using image URLs on Salesforce and/or external websites
- Using Flows or Apex Triggers to communicate with SharinPix
- Using albums on Salesforce Experience Cloud or web forms
- Synchronizing the SharinPix mobile application
- Logging into and navigating on the SharinPix administration dashboard
- Importing images using URLs or Salesforce files (Attachments, Content Documents)
- Communicating with SharinPix API endpoints via REST
- External users accessing shared URLs of albums or images
Usage Examples
If a user from an organization opens 10 albums with 20 images each and views every image, he has already consumed at least 210 API calls (loading 10 albums + viewing 200 images). 100 users doing the same actions equals 21,000 API calls. At the same time, if a developer working on the same organization creates 10,000 imports on SharinPix, an additional 10,000 API calls will be used. The total usage for the day would be 31,000.
If a client displays 100 images hosted on SharinPix on their website and receives 5000 visitors in a day, each visitor will use up 100 API calls, totalling 500,000 API calls.
If a user on the field takes 100 pictures, each at different times of the day, using the SharinPix mobile app, and goes home to connect to the WiFi for the file uploads to begin, at least 100 API calls will be used to register the uploads and check on the status of those upload with the SharinPix server.
If a developer working on an organization has custom code that queries the number of SharinPix images present on a Salesforce record every time a record is viewed, the API call usage will depend on the number of records viewed by users in 24 hours.
Default Rate Limit Settings
By default, organizations are subject to a rate limit of 1000 API calls per user per 24 hours. The limits are not applied on a user-by-user basis but rather globally across the organization.
An organization that has purchased 50 SharinPix user licenses is limited to 50,000 API calls in 24 hours (50 x 1,000). Provided the organization's total number of API calls remains under 50,000, a single user may be responsible for using 40,000 API calls without getting blocked or blocking any other user from the organization.
This value is visible to the client’s administrator via the SharinPix admin dashboard.
Clients may request an increase in their rate limit if their usage patterns suggest insufficient default limits. SharinPix administrators can adjust the rate limit based on the client’s contractual agreement or operational needs.
Requesting Higher Limits
Clients who require a higher rate limit due to their specific use case can negotiate for increased API limits by contacting SharinPix at [email protected]. Justifications, such as increased usage, new features, or integrations, will speed up the processing time.
This will connect you with an expert from SharinPix, with whom you can negotiate new limits. SharinPix will assess each request on a case-by-case basis, considering the organization's usage patterns, contract terms, and the value of their agreement. Rate limit increases may not be granted automatically and may be subject to additional fees or amendments to the client’s service contract.
Consequences of Exceeding API Limits
Each API call counts toward an organization’s daily limit. An organization’s administrators will receive a warning email when 80% of allocated API calls are reached. Once an organization exceeds 100% of its allocated API limit, all users of that organization will experience service disruption and receive an error message indicating that the API limit has been reached. This error will affect all SharinPix components, including the Album component. API-based interactions included in Apex methods and Flows will cease to function. Image URLs being used on web pages will show broken images. Shared URLs will show error messages.
Restoration of Services
Once the rate limit is reached, SharinPix services will be blocked for that organization to prevent system strain and ensure fairness across all clients. The block will remain in place until the rate limit resets, which occurs automatically 24 hours after the first API call is made. Upon reset, SharinPix services will become available again without any action required from the client.
Unblock Requests
In the event an organization reaches its API limit, users may also request unblocking by submitting a support request to [email protected]. SharinPix will evaluate the request and may provide temporary relief depending on the specific circumstances and the client's contractual terms. SharinPix also encourages clients to proactively engage with support to discuss usage concerns or future needs.
Handling Excessive API Usage
Communication about Bulk Operations
Clients conducting bulk operations must notify SharinPix in advance. These operations can include:
- bulk image imports (e.g., importing images via URLs or Salesforce files)
- large-scale data synchronization (e.g., running image sync operations)
- high-frequency API usage
This notification allows SharinPix to monitor the API activity and, if necessary, temporarily adjust rate limits to prevent service disruptions.
High Web Traffic
Publicly shared image URLs will consume API calls each time the image is accessed. Clients must consider this when using SharinPix services for public image distribution.
Clients using SharinPix albums or images on Experience Cloud sites or public websites must communicate with SharinPix to negotiate higher limits in advance if they deem current limits insufficient.
Unintentional Overuse
Inefficient or misconfigured Salesforce Apex code, Flows, or integrations may unnecessarily trigger excessive API calls. Clients are responsible for ensuring their Salesforce environment does not contain poorly optimized code or integration that could inadvertently consume excessive API calls.
SharinPix encourages clients to regularly audit their internal systems to prevent accidental API call overuse. If clients suspect overuse due to internal issues, they may contact SharinPix support for assistance. SharinPix reserves the right to review API usage patterns and suggest corrective actions to prevent misuse or unintentional overconsumption of resources.
Fair Use Compliance
This Fair Use Policy is fundamental to SharinPix’s commitment to providing reliable and equitable access to its services for all clients. No single client should adversely affect the service experience of others. By adhering to the rate limits and notifying SharinPix of potential overuse, clients help maintain the stability and performance of the SharinPix ecosystem.
High consumption can also indicate a security breach, unauthorized access, or even bad programming practices. This highlights that rate limits also serve as a crucial security measure, protecting both SharinPix and its customers by preventing unintended or malicious overuse. Adhering to these limits safeguards the integrity of client data and the overall platform.
SharinPix reserves the right to modify API limits and take action against organizations that abuse the service or consistently exceed their assigned limits without proper communication. In cases of abusive or excessive API usage, SharinPix reserves the right to limit or suspend access to services as necessary to protect the interests of other clients.
Policy Updates
SharinPix reserves the right to modify or amend this Fair Use Policy at any time. Any significant changes will be communicated to clients via email or through their designated SharinPix Customer Success Representative. Clients are encouraged to review the Policy periodically for updates. Continued use of SharinPix services will constitute acceptance of the updated policy.
Contact
If you have questions or concerns about this Fair Use Policy or would like to request rate limit adjustments, please contact SharinPix Support at [email protected].
---
This document ensures that clients are aware of the boundaries around their usage of SharinPix services and provides a framework for fair and transparent service management.
0 Comments
Add your comment