Contact Sales
Become a Partner

API Policy

ARATUM HORIZONS API POLICY 

Date of Last Revision: 3 January, 2024 

Aratum Singapore PTE. LTD., (and its affiliate(s), collectively “Aratum”) has developed this Horizons API Policy (“API Policy”) which governs each individual’s (“you” or “you”) use of the Horizons API.

Modifications to Policy

Aratum reserves the right, in its sole discretion, to modify this 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 API Policy and the Horizons API functionality, see the Deprecation and API Changes section below.

Principles 

Applications that access the Horizons API should adhere to the following principles:

  • Don’t impersonate.
  • Don’t surprise users. 
  • Respect the privacy of any information retrieved. 
  • Don’t overload users. 
 
Additionally, your applications must adhere to Horizons API rate limits (see the API Rate Limits section below). 
 
Don’t Impersonate 
  • Your application should not mirror or replicate Aratum, Horizons, or any other organization using Horizons. 
  • Do not impersonate or facilitate impersonation of others in a manner that can mislead, confuse, or deceive users. 
  • End users should understand that your application is integrated with Horizons but is an independent resource. 
  • You should not remove or alter any proprietary notices in the Horizons API. 
 
Don’t Surprise Users 
  • Your application should not do the following. 
  • Use the Horizons API for different purposes other than what your application states or implies; 
  • Confuse or mislead users about the source or purpose of your application; 
  • Use business names and/or logos in a manner that can mislead, confuse, or deceive end-users; 
  • Use the Horizons API on behalf of any third-party; or 
  • Facilitate or encourage the publishing of links to malicious or obscene content. 
 
Your application must outline what actions your application will take on the end-user’s behalf as part of the application registration process. 
 
Respect the Privacy of any Information Retrieved 
  • Any end-user information—including course enrollments, grades, profile information, etc.—retrieved through the Horizons API should be considered private information and, in some cases, will be protected by law and regulations. 
  • Know what information your application will disclose to the public or to other products and services, and be clear with end-users about what information will be disclosed. 
  • Do not facilitate or encourage the publishing of private or confidential information. 
  • Respect the intellectual property rights of others. 
 
Don’t Overload Users 
Horizons provides a number of different ways to contact, notify, and inform end-users of information. Where these methods are exposed in the Horizons API, it’s important to monitor how often your application is pushing information to end-users. 
 
In general, you should try to push information as rarely as possible, both to prevent end-user annoyance and also to make your pushes more effective. 
 
API Rate Limits 
Applications that access the Horizons API must not place undue load on Horizons servers. Horizons has an automatic rate limiting provision that dynamically adjusts as more concurrent and/or expensive requests occur. When the rate limit is exceeded, Horizons API requests will fail. Rate limiting is enforced per user access token so that partners who perform requests on behalf of multiple end-users will not be throttled per developer access token that they hold. 
 
If an application regularly exceeds the API rate limits or uses a disproportionately large number of high-impact (e.g. non-GET) requests, Aratum may revoke your access tokens, or take other measures to ensure the stability of the Horizons for all users. 
 
If you are concerned about hitting the rate limit, please contact your Customer Success Manager to seek assistance optimizing your application for lower impact on Horizons performance. 
 
Deprecation and API Changes 
The Horizons API is versioned to allow for future enhancements. Aratum strives to deliver a platform that is stable, consistent, and secure so you can confidently build awesome on top of Horizons APIs. 
 
Aratum will add, change, and remove API endpoints and fields from time to time using commercially reasonable efforts to provide communication as indicated: 
Type of Change Notice
Remove an endpoint Endpoint will be marked DEPRECATED at least 90 days before endpoint is removed
Remove a documented field in a result set Field will be marked DEPRECATED at least 90 days before field is removed
Remove an undocumented field in a result set Undocumented fields can be removed or changed without notice
Add a field to a result set Field can be added without prior notice
Add to the attribute set of a field in the result set New values can be added to a field without prior notice
Change the attribute set of a field in the result set Field value will be marked DEPRECATED at least 90 days before attribute is changed
Remove the attribute set of a field in the result set Field value will be marked DEPRECATED at least 90 days before attribute is removed
Change to BETA endpoints, fields, or attributes Can be removed or changed without prior notice
Changes related to fixing a security vulnerability Any change related to repairing a security vulnerability could be made without prior notice
Aratum has no liability to you as a result of any change, temporary unavailability, suspension, or termination of access to the Horizons API. Information and notices regarding Horizons APIs can be found in the Horizons Production Release Notes. API Support Developers on cloud-hosted Horizons can submit questions about or issues with the API to the Horizons Support team in one of the following ways:
  • Email  support@aratum.com
  • Open the Help Menu in Horizons and select the Report a Problem option
Tickets that are submitted related to the Horizons API will be handled by Aratum following the same service-level agreement that applies to any other ticket from a customer.

Copyright ©2024 Aratum
Your use of this website signifies that you accept our Terms of Use.

© 2024 Aratum or an Aratum affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Aratum or an Aratum affiliate company. The information contained herein may be changed without prior notice. Some software products marketed by Aratum and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by Aratum or an Aratum affiliate company for informational purposes only, without representation or warranty of any kind, and Aratum or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Aratum or Aratum affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. In particular, Aratum or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Aratum’s or its affiliated companies’ strategy and possible future developments, products, and/or platforms, directions, and functionality are all subject to change and may be changed by Aratum or its affiliated companies at any time for any reason without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions. Aratum and other Aratum products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Aratum (or an Aratum affiliate company) globally. All other product and service names mentioned are the trademarks of their respective companies. See aratum.com for additional trademark information and notices.

New Whitepaper

Cybersecurity in the AI Era: Shielding The Supply Chain

Download Now