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

Was this helpful?

  1. API Migration Policies

API Blackout Test Email Template

Sample email template announcing individual blackout test schedules. Check and modify necessary dates, URL and other info before sending the email.

PreviousMigration Email TemplateNextAPI Deprecation Email

Last updated 4 years ago

Was this helpful?

Sub: Important! V1 API Blackout Test on yyyy-mm-dd

Dear valued customer,

Platform of Trust will be performing scheduled blackout tests on the V1 APIs on <yyyy-mm-dd> at <hh:mm> <timezone> for upto <number of hours>.

During the blackout test period, you might not be able to access the V1 APIs.

It won't be possible to create identity networks, data products, and generating harmonized data during this period.

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

However, you will be able to use all V2 APIs in Platform of Trust. Please check the .

It should be possible to send requests to all V1 APIs once the blackout test is complete.

The blackout test will start on <yyyy-mm-dd> at hh:mm <timezone> and could last upto <number of hours>.

Start time

<yyyy-mm-dd>, <hh:mm> <timezone>

Estimated duration

<number of hours>

APIs, environments and services affected

The following APIs will not be accessible in Sandbox, Staging, and Production Environments:

Access Control List (ACL) API V1 Application API V1 Broker API V1 Context API V1 Identity API V1 Login API V1 Product API V1

Mark the date for the blackout test in your calendar by using the calendar invite in the attachment.

We apologize for any inconvenience caused to you due to this scheduled blackout test.

Best Regards,

Jaro Lexmond

API Product Owner, API coordination & tech support

jaro.lexmond@oftrust.net

+358 40 900 3598

PLATFORM OF TRUST | SIGNSPACE

part of Vastuu Group

Notes for the development team

Make sure to add additional possible consequences that might result from the blackout tests.

The calendar invite should be sent along with the email either as attachment or a direct download link.

Sandbox environment: Staging environment: Production environment:

Ontology Viewer:

The email template is saved in under Sandbox domain. This domain is used for testing purpose. When it is sent to actual customers, the domain notifications.oftrust.net should be selected from available domain and the template should be added there.

documentation here
https://world-sandbox.oftrust.net/
https://world-staging.oftrust.net/
https://sandbox.oftrust.net/
standards.oftrust.net/v2
MyWorld Standard
View full scheduled blackout test details
Mailgun