Platform of Trust Platform Design Guide
Developer Portal
API Docs
Ontology
Search
⌃
K
Links
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
API Testing
Tests cover all endpoints with valid, invalid and empty parameter values
Verify that
response codes
are appropriate
General API guidelines - Previous
Pagination, partial response and sorting
Next - API Headers
Mandatory elements & behaviour
Last modified
4yr ago
