Skip to content

AEPs

Meta

1 AEP Purpose and Guidelines

2 AEP Numbering and Organization

3 AEP Versioning

4 API Versioning Strategy

5 Designing an API

8 AEP Style and Guidance

General

101 OpenAPI

218 Organization ID

HTTP

62 URLs

63 Status Codes

64 HTTP Methods

65 GET

66 POST

67 PUT

68 PATCH

69 DELETE

105 Content Negotiation & Media Types

106 Query Parameters

REST

50 Representational State Transfer

51 REST vs. Alternative API Architectures

Resources

121 Resource-oriented design

122 Resource paths

126 Enumerations

156 Singleton resources

159 Reading across collections

Actions

130 Actions

131 Fetch

132 List

133 Create

134 Update

135 Delete

136 Custom Actions

137 Apply

Fields

107 JSON Payloads

142 Time and duration

148 Standard fields

Design Patterns

151 Long-running operations

154 Preconditions

155 Idempotency-Key

157 Partial responses

162 Resource Revisions

164 Soft delete

193 Errors

214 Resource expiration

216 States

217 Unreachable resources

Security

211 Authorization checks

Best Practices

192 Documentation