Skip to main content

Types of APIs

APIs are generally classified into the following types:

TermExplanation
Public APIBuilt for external access. 'Open' does not always mean free; security is crucial.
Partner APIIntended for partners, often optimised for their processes. Security is essential.
Internal APIsRestricted to internal networks, primarily involving one provider and one consumer. Often used for legacy systems and internal communications.

WPP-specific API types are yet to be defined.

This document applies to all API types, but guidelines may vary per type. The guidelines are documented in the following way:

Instructional image

(A) API type applicability: Internal, Private, Partner, and Public APIs. Internal API standards in this document apply to APIs on the same platform as the initiating API but can extend to others.

(B) Design Authority enforcement:

  • Must: Compliance is mandatory; non-compliant deployments to acceptance are blocked.
  • Should: Compliance is expected, but temporary deviations may be allowed with justification and a compliance plan.
  • Could: Optional but recommended criteria, allowing deployment even if not met.