...
This page defines a number of requirements that all trust framework APIs must conform to.
| Excerpt |
|---|
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST validate that all received API calls conform to the DSGO trust framework
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST validate that all responses to API calls conform to the DSGO trust framework
|
|
...
| Excerpt |
|---|
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST define the default base URL of API endpoints following the <domain-name>/<path>/resources format, where <domain-name> is server specific and <path> is an optional URL path
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST define the default base URL of API endpoints without a trailing slash
|
|
...
To ensure that API performance requirements can be met, only limited data should be returned the amount of data in an API call . Therefore, the size of data sent via APIs is limitedshould be limited. Depending on the service, only a reasonable amount of data should be included in API calls. If the party sending the API request requires additional or specific data, this can be requested using optional URL query parameters.
| Excerpt |
|---|
| name | Generic API body content |
|---|
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties SHOULD limit API responses calls to include only a reasonably sized amount of data
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST NOT include HTTP bodies in GET or DELETE requests
|
|
...
| Excerpt |
|---|
| name | Generic API url parameter |
|---|
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MAY include query options for functionalities such as filter, sort, and page in their API endpoint as defined in OData 4.01
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST reject any requests that contain unsupported url parameters with a 501 Not Implemented as defined in OData 4.01
|
|
...
| Excerpt |
|---|
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST make caching explicit to API users
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST include the following headers in the API response when it is not cacheable:
cache-control: no-store
pragma: no-cache
|
| Panel |
|---|
| panelIconId | 2705 |
|---|
| panelIcon | :white_check_mark: |
|---|
| panelIconText | ✅ |
|---|
| bgColor | #FFF0B3 |
|---|
| DSGO.Basis: Parties MUST include the following headers in the API response when it is cacheable:
cache-control: max-age=31536000
Note: max-age MAY vary
|
|