eCG API Guidelines
Introduction
Overview for the busy developer
History
Advantages
The future
Conventions
Principles
Technical principles
URLs and URIs
Base URL
URL and URI naming
Query parameters
Resource representation format
Resources
Binary resources
Resource collections
Relation names
Field names
Field values
Errors
Interaction design
Request methods
Status codes
Webhooks
It should be possible to programmatically register webhooks via the api
Webhooks may be registered on all resource types
The body of a callback must be a HAL resource
HTTP callbacks should be signed
Events pushed to the consumers may additionally be exposed in a collection resource
Documentation requirements
Documentation URLs
Resource documentation
Document link relations
Getting started guide
API reference
Example code
TODO
Security
Authentication
OAuth 2
Versioning
1. Backward compatible changes
2. Resource representation changes
3. Resource behavior changes
HAL and our deviations
Content-type
JSON
Field names
TODO
Lots of small edits
eCG API Guidelines
Docs
»
Index
D
|
H
|
I
|
O
|
P
|
R
|
S
|
U
|
V
|
W
D
Documentation
H
HAL and our deviations
I
Interaction design
Introduction
O
OAuth
P
Principles
R
Resource Representation
S
Security
U
URLs and URIs
V
Versioning
W
Webhooks