Signed in as:
Modifications to Policy
Pearl PHR (Teledactyl ) reserve the right, in its sole discretion, to modify this Pearl PHR or Teledactyl Software API Policy at any time. You are responsible for reviewing and becoming familiar with any modifications. Modifications are effective when first posted. To receive notifications about changes to this policy and the API functionality, see the Deprecation and API Changes section below.
Principles
Applications that access the Pearl PHR or Teledactyl Software API should adhere to the following principles:
Additionally, your applications must adhere to API rate limits where applicable (see the API Rate Limits section below).
Don’t Impersonate
Don’t Surprise Users
Your application should not…
Your service should outline what actions your application will take on the user’s behalf as part of the application registration process.
Respect the Privacy of any Information Retrieved
Don’t Overload Users
IX cloud provides a number of different ways to contact, notify, and inform users of information. Where these methods are exposed in the API, it’s important to monitor how often your application is pushing information to users.
In general, you should try to push information as rarely as possible, both to prevent user annoyance and also to make your pushes more effective.
API Rate Limits
Applications that access the Pearl PHR Or Teledactyl Software or Services API’s must not place undue load on Teledactyl servers or infrastructure. Teledactyl will monitor, limit and in some cases terminate excessive use . Where applicable when the rate limit or number of calls is exceeded, API requests will fail. Limiting is enforced per user access token (and tenant) so that partners who perform requests on behalf of multiple end users will not be throttled.
If an application regularly exceeds the API rate limits or uses a disproportionately large number of high-impact (e.g. non-GET) requests, the access tokens may be revoked, or other measures may be taken to ensure the stability of the system for all users.
If you are concerned about hitting the rate limit, please contact your Customer Success Manager to either adjust your rate limit or seek assistance from our or other paid for professional services optimizing your application for lower impact on the provided Software or Services and to improve overall performance.
Deprecation and API Changes
The Pearl PHR and Teledactyl Software and Services API’s are versioned to allow for future enhancements. We strive to deliver a platform that is stable, consistent, and secure so you can confidently build scalable solutions on top of our APIs. Over time we will add, change, and remove API endpoints and fields from time to time using commercially reasonable efforts to provide communication and backward compatibility where possible as indicated:
Type of change
Notice
What you should do
ToC-Remove an endpoint
Endpoint will be marked DEPRECATED at least 60 days before endpoint is removed
Watch release notes
ToC- Remove a
documented field in a result set
Field will be marked DEPRECATED at least 60 days before field is removed
Watch release notes
ToC-Remove an undocumented field in a result set
Undocumented fields can be removed or changed without notice
Avoid using these fields or be aware that they could be experimental and could change at any time
ToC-Add a field to a result set
Field can be added without prior notice
Write your code to be resilient to these types of changes
ToC-Add to the attribute set of a field in the result set
New values can be added to a field without prior notice
Write your code to be resilient to these types of changes
ToC-Change the attribute set of a field in the result set
Field value will be marked DEPRECATED at least 60 days before attribute is changed
Watch release notes
ToC-Remove the attribute set of a field in the result set
Field value will be marked DEPRECATED at least 60 days before attribute is removed
Watch release notes
ToC-Change to BETA endpoints, fields, or attributes
Can be removed or changed without prior notice
Watch release notes
ToC-Change to Sandbox endpoints, fields, or attributes
Can be removed or changed without prior notice we will
make best effort to give at least 5 days
Watch release notes
ToC- Changes related to fixing a security
vulnerability
Any change related to repairing a security vulnerability could be
made without prior notice
Watch release notes or security notifications where
applicable
Teledactyl has no liability to Customer as a result of any change, temporary unavailability, suspension, or termination of access to the API.
Information and notices regarding the available APIs can be found in the technical documentation on the website and in Pearl PHR API Release and Documentations as and where applicable.
API Support
Developers using iCloud Services provide by Teledactyl can submit questions or issues with the API to the Support team in one of the following ways:
Tickets about the API will be handled following the same service-level agreement that applies to any other ticket from a given organization.
Developers who are not part of an official program can get support through the developer community:
Rev. May 15, 2021
We use cookies to analyze website traffic and optimize your website experience. By accepting our use of cookies, your data will be aggregated with all other user data.