Please enable JavaScript.
Coggle requires JavaScript to display documents.
MAXSys API - Coggle Diagram
MAXSys API
Scope : Core vs Integrated
Separation of what to be integarted vs what is not
Where will be the demand for integration
ROI info attached to each integration option to prioritise the development accordingly
Rate of change or stability of the area
More stable more easier to wrap logic in API
USPs to be core vs commodities to be integrated ??
Classifications
Core services - No API
Partner API - exposed to selected partners only
Public APIs
Performance
SLAs
Throttling considerations
Latency requirements
Definition of thresholds
Availability requirements
Error rate targets
Concurrency
API discovery
Developer portal
API documentation
SDKs
Sandboxes for testing
Release notes
search and filter by category
Loyalty
Promotions
Reporting
Web hooks ?
Event driven integrations ?
Conisder developer perspective as we expect broader usage
Documentations and usability
SDKs
API documentation
Standards on naming and error messages etc
Consistency
Guidelines and best practices
Onboarding
Security
Data security - get the better wording for this
Token encryption requirements
Access control
Risks
Inconsistencies
Security
Impact to compliance matters
Commericials
Tier approach
Free
Sandbox env
Just for testing and no commercial usage
Standard
Very Basic access
Slalller venues
Premium
Priority support
May be for larger venues
Partner tier
Revenue sharing option
White labeling ?
for Exclusions ??
Billing Models
per API call
Per Active Venue/ User
Subscriptions
Governance
Versioning and life cycle management
version policy
deprecation policy
Compliance
Auditability
Traceability
Alerting and Monitoring