Davies Meyer – home
    Tech3 min read

    API (Application Programming Interface)

    An API is an application programming interface: defined features and rules through which software uses other software. It can provide data or enable actions. APIs exist between web services, in operating systems and within software libraries; not every API is an internet connection.

    API (Application Programming Interface) explained

    For an integration, the interface is a contract: Which request is accepted, what response is returned and which errors can occur? Two systems having an API does not automatically make them compatible. Field meanings, permissions and workflows must also align.

    Consider sending a confirmed enquiry to a CRM. Required fields, duplicate-handling rules and feedback about processing need to be defined. Technically successful transmission does not establish that the enquiry entered the right workflow. Check the outcome in the destination system.

    Plan for limits and changes too. What happens with a slow response, expired access or a changed interface version? Documented ownership and traceable error handling make later operation easier.

    Creative Engineering connects the intended user action with the necessary systems. Better quality may mean information reliably reaches the right place and manual transfer is avoided. Whether the integration delivers that value is checked against the complete journey.

    Examples

    Hypothetical application

    A service form should create an enquiry in a CRM. A test reveals that the destination requires an additional product identifier. The team adds the mapping and also checks repeated transmission so the same enquiry is not created twice.

    Key Points

    • An API is an interface, not a completed integration.
    • Clarify data meaning and permissions together.
    • Check transmission and processing separately.
    • Consider failures and future changes.

    Practical application

    Describe required data and actions, including failure cases. Then test the complete journey through to correct processing in the destination system.

    Useful measures

    Correct processing

    Follow selected operations from their source to the destination system.

    Errors and repetitions

    Investigate incomplete, failed or duplicate operations.

    Operating effort

    Include maintenance, version changes and error investigation.

    Common mistakes

    • Selling the availability of an API as a completed integration.
    • Equating technically similar fields without checking their meaning.
    • Inferring automatic data quality or advertising impact from server-side transmission.

    Sources and context

    • MDN: API

      Defines a programming interface as features and rules for use by software.

    Frequently Asked Questions about API (Application Programming Interface)

    No. A website serves people; an API describes ways for software to interact. A website may itself use APIs.

    Loading related terms…

    All Terms