Sunbreak API v1 Documentation
Sunbreak's API exposes the entire Sunbreak infrastructure via a standardized programmatic interface. Using Sunbreak's API, you can do just about anything you can do on in your WordPress admin dashboard.
The Sunbreak API is a RESTful API based on HTTPS requests and JSON responses. If you are registered with Sunbreak, you can obtain your API key from the bottom of the "API Tokens" page, found here: Go to My account.
What is Sunbreak?
Sunbreak is the digital personalization engine that accelerates engagement with your websites. Sunbreak unlocks the power of content targeting, enabling you to create highly-engaging and dynamic experiences for your customers.
Audience for APIs
Sunbreak offers public APIs with three audiences in mind.
- Sunbreak customers
- Sunbreak partners
- Developers
Customers: Individuals and organizations all over the world choose Sunbreak to personalize their webpages and accelerate engagement with their target audiences. Most customers manage their settings in the web dashboard, built using these APIs. Virtually anything you can do in the WordPress admin dashboard may be done via API. Example: fetching a block of content from the Sunbreak edge cache for a single web page.
Partners: Many organizations make using Sunbreak a seamless option for improving their customers' engagement. These APIs make that easier to do at scale. Example: a Sunbreak Certified Partner may use APIs to add functionality to an existing WordPress block.
Developers: Developers all over the world create useful applications which tie into Sunbreak services. These applications may include plugins and extensions to popular content management systems, apps that are offered in the Sunbreak Apps marketplace, runbooks for specific deployment systems, and many others.
Do's and Don'ts
What can you build with Sunbreak APIs?
Anything that's useful and follows the guidelines presented here.
What should you avoid doing with Sunbreak APIs? Do not do any of the following:
- Abuse Sunbreak systems or customers
- Misuse Sunbreak trademarks
- Misrepresent Sunbreak services as your own
Abuse: Follow all guidelines, including the rate limits defined below. Your ability to use the Sunbreak APIs may be terminated, temporarily or permanently, if our systems are abused. Similarly, anything in an application which goes against the goal of making Sunbreak more useful to Sunbreak customers or attempts to mistreat customers or their data will be grounds for termination.
Trademarks: Sunbreak has several registered trademarks. Details on how and when you may use Sunbreak trademarks are found at https://www.sunbreak.io/trademark, with links to specifics on logo use and spelling. Please review carefully.
Misrepresentation: Draw a clear line between the benefits you provide in your application and those benefits of the Sunbreak service that you enable via API. The APIs are not intended for "white labeling" or reselling Sunbreak services as your own. Nothing in your service or application should create a false sense of endorsement, sponsorship, or association with Sunbreak. You may sell your own application or service which utilizes the Sunbreak APIs, but may not sell Sunbreak services to customers without a commercial agreement with Sunbreak. The full Sunbreak Terms of Use are found at https://www.sunbreak.io/terms.