API

An API (application programming interface) provides functions and data so that software can communicate with other systems. Web APIs embed external services such as Google Maps or YouTube. Shopware 6 is built API-first with the Admin, Sync and Store APIs.

API (application programming interface) is a term from software development. It refers to an interface for application programming. This kind of “program component” gives software developers and programmers important information and data about a piece of software (for example an operating system) or application. On this basis, suitable programs can be developed and written for it.

A good example is the iOS operating system that Apple uses for the iPhone and iPad. For developers to write apps for the operating system, they need information about the commands, functions and protocols of iOS. Apple provides this through its programming interfaces.

Web APIs as a special form of programming interface

In addition to classic programming interfaces within a piece of software, there are web APIs. They enable data to be exchanged and processed over the internet – for example between your shop and an external service. A well-known example is Google Maps: many websites embed maps and directions directly, without visitors having to leave the site. This is made possible by the Google Maps APIs, which give developers an interface to the map service. Embedding videos from YouTube works in a similar way.

Interfaces for sign-in and permissions are also widely used: with authentication, users log in to a new website using an existing account – for example with “Sign in with Google” or “Sign in with Apple”. With authorisation, users allow an application to access certain data or functions of another service on their behalf, usually via the OAuth standard.

Advantages of well-documented programming interfaces

Well-documented, easy-to-understand APIs give companies the opportunity to improve their systems and expand their offering. If information and data are accessible and well described, developers and partners can program additional software. This creates a varied ecosystem around a piece of software or hardware – which users appreciate. However, APIs are not always free to use: many providers require registration, set usage limits or charge fees. Apple is an example here too: development takes place in the Xcode development environment on a Mac, and anyone who wants to publish apps in the App Store needs a paid membership of the Apple Developer Program.

Shopware's API-first approach

Shopware 6 also takes advantage of APIs with its API-first approach. All shop functions can be controlled via interfaces. This makes it easier and faster to connect ERP, PIM, merchandise management or additional sales channels and integrate them into the shop system during shop development.

Types of APIs in Shopware:

Admin API: used to manage the online shop. Settings and functions in the admin area can be configured through it.
Sync API: part of the Admin API, designed to import and export large volumes of data efficiently – for example when syncing with the ERP system.
Store API (formerly Sales Channel API): gives access to all storefront functions, from the shopping cart to the customer account. This means any frontend can be connected – such as your own app, a headless solution or an additional sales channel.

Overall, this approach allows shop owners to work much more flexibly with Shopware and manage data centrally.