Revel Platform Guidelines

We want developers and partners to have a great experience building on the Revel API while simultaneously creating a great experience for your customers, whether that's internal or external.

We've written these guidelines for anyone using Revel’s products and services, to show you how to use Revel and our APIs, and to share best practices as we, and you, continue to build new and exciting products and services.

Before you start using the Revel API, we'll ask you to confirm that you've read and agree to the API/XML terms of use.

Let's turn it over to our legal team for the fine print...

Please use Revel’s products and services responsibly

Our products, services, and brand are important to us, and we ask that you not do anything that might damage them.

  • We expect data produced with Revel's products to be represented transparently and honestly. Don't misrepresent data created by our products.

  • We expect you to use our products and services to help serve your customers. Don't re-sell, re-purpose or license any data obtained from Revel. Don’t use our products to create a service that competes with Revel or infringes on our copyright.

  • Don’t reverse engineer the Revel platform, and don't re-sell, transfer or sublicense our code, APIs, or products.

  • Don’t use spiders, robots crawlers, data mining or similar tools to scrape the Revel website or APIs.

  • Revel needs to monitor your access to our API so don’t block us from doing so.

  • Respect our rate limits. Don’t abuse or overuse our APIs or resources – we expect you to comply with any fair usage guidelines we publish.

  • If you have an idea about improving the Revel product or if you would like to try something experimental then please let us know and we'd be happy to discuss with you.

  • You can use our logo and branding where you have the right to do so, but please don’t do anything that could damage Revel's brand integrity or be misleading or confusing to customers. This includes using our logo in any part of your logo, using the Revel name in your app name or anything else that could be considered an abuse of our branding, logos or copyrighted materials.

Treat your customers and their data responsibly

We treat our customers' data with the utmost respect in regards to security and privacy, and we go to great lengths to make sure all data sent to and from Revel is handled securely.

We expect users of the Revel API to treat our customers' data with the same respect and responsibility. Our terms for developers include:

  • You must have appropriate measures in place to protect any information you receive from Revel against unauthorized access, use, or disclosure.

  • You must only use the data you need to build your product or service.

  • You must have an end user agreement and a privacy policy in place with respect to each of your customers - and it must be compatible with Revel's terms.

  • You must ensure you're meeting all your legal obligations regarding applicable data protection and consumer protection. Don’t use Revel's products with data you don't have permission to process.

  • You must be able to meet the requirements of the European Union's General Data Protection Regulation (GDPR) for any data you process which falls within the scope of the legislation and fulfill access requests as required.

  • In addition to breach notifications required under GDPR, you'll notify Revel of any personal data breaches within 72 hours of becoming aware of a breach.

  • You must grant Revel permission to audit your data processing activities. This can include independently produced audit reports.

Further Information

These guidelines sit alongside and are in addition to the API Terms of Service and Privacy Policy. Make sure you've read and understood these documents; this page is not a substitute for reading the full terms. If we feel you are misusing our products or services, we reserve the right to withdraw access to our products and services entirely.

Both these guidelines and the full terms will evolve with time, so check back regularly to make sure you haven't missed any changes. Please get in touch if you have any feedback or suggestions for making them better.

If at any time you are concerned that these guidelines may have been breached, please do notify us as soon as you become aware.