Platform of Trust Platform Design Guide
Developer PortalAPI DocsOntology
  • Purpose and scope
  • Developer eXperience Strategy
  • Suggest changes
  • API Requests
    • Request validation
    • Response codes used
    • Error handling
  • General API guidelines
    • Performance
    • Documentation
    • Data models used
    • Use HATEOAS
    • Use HTTP Methods
    • Dates and time
    • Naming conventions
    • Pagination, partial response and sorting
    • API Testing
  • API Headers
    • Mandatory elements & behaviour
    • Rate limiting information
  • API Security
    • Authentication and authorization
    • SSL everywhere - all the time
  • API versioning guidelines
    • Versioning Rules
    • Breaking changes
    • Non-breaking changes example
    • Retirement process
    • Add new API to documentation
    • Add new endpoint
  • API Migration Policies
    • Deprecating API
    • Sunsetting API
    • Blackout Testing
    • Migration Email Template
    • API Blackout Test Email Template
    • API Deprecation Email
    • Deprecating an older API
  • Ontologies
    • About ontologies
    • Web Ontology Language, OWL
    • Ontology editor
    • Edit ontology
    • Add new subclass
    • Naming convention logic
    • Extending the ontology
  • Design Guideline
    • Colors
    • Typography
    • Grids and Space
    • Input forms - Text field
    • Input forms - Text area
    • Buttons
    • Checkbox
    • Radio buttons
    • Date picker
    • Form control - Single select
    • Toggle
    • Pagination
    • Status pills
    • Tables
    • Effects
    • Dialogues
Powered by GitBook
On this page
  • What is a blackout test
  • Executing API Blackout Tests

Was this helpful?

  1. API Migration Policies

Blackout Testing

PreviousSunsetting APINextMigration Email Template

Last updated 4 years ago

Was this helpful?

What is a blackout test

A blackout test is a planned, timeboxed event when we will turn off a certain API or some of the API capabilities. The test is meant to help developers understand the impact the retirement will have on the applications and users.

Executing API Blackout Tests

Blackout tests will be scheduled in advance and they should be performed approximately 1-2 months before sunset date of the API. Customers will get announcing and reminding emails prior to the date when tests will be executed. The email will include the date, time (inc. timezone), estimated duration of the blackout test, affected APIs and services, and alternate APIs to use during this period. A sample email template can be found here.

In addition, social media is used for notifications so please follow on Twitter to receive notices about blackout tests.

We will execute at least 3 API blackout tests where customers will be unable to request older API versions in any environments (e.g. Sandbox, Production, etc.). Tests will take place on a different days of the week and at different times of the day.

During the tests, APIs will respond with HTTP status code: 410 Gone

@PlatformOfTrust