Medipim Web API documentation
Medipim is a Product Information Management system. The Medipim dataset contains rich product information — including product details, images (packshots, product shots and more), PDFs, brands, and categories.
What is the Web API?
A Web API (Application Programming Interface) is a way for software systems to communicate with each other over the internet. Instead of a person browsing the Medipim platform manually, a program can send requests to the API and receive structured data in return. This makes it possible to automate tasks that would otherwise require manual work.
The Medipim API is a REST API, meaning it follows a widely adopted standard where data is accessed through URLs using familiar HTTP methods like GET and POST. Data is exchanged in JSON format, which is supported by virtually every programming language.
What can you do with it?
Common use cases include:
- Synchronizing product data — automatically keep your webshop, ERP, or internal systems up to date with the latest product information from Medipim.
- Importing and exporting media — programmatically download product images and PDFs, or upload new media to Medipim (provided you have the correct permissions).
- Building integrations — connect Medipim to other systems in your workflow, such as e-commerce platforms, PIM tools, or data pipelines.
- Querying the dataset — search, filter, and retrieve products, brands, and categories based on your needs.
Who is this for?
This documentation is written for developers and integrators — people who write code that connects to the Medipim API. You'll typically be building a backend service, a scheduled script, or a data pipeline that runs on a server.
In this documentation
- Getting started — environments, authentication, and your first request
- Authentication — how authentication works, with code examples
- Key concepts — languages, target groups, identifiers, descriptions, and more
- Media types — photos, frontals, links, and image guidelines
- Uploading media — uploading images and PDFs, file naming, and automatic product linking
- Error handling — error codes and how to resolve them
- Throttling & quotas — rate limits and how to deal with them
- FAQ — common questions and integration tips
The API Reference documents every endpoint with full request and response schemas. Each endpoint has an interactive panel where you can enter your credentials, send requests, and see live responses directly in the browser — no code needed. It also generates code examples in many different languages.
OpenAPI specification
The Medipim API is described by an OpenAPI specification file, which you can download from the API Reference page.
OpenAPI (formerly known as Swagger) is an industry-standard, machine-readable format for describing REST APIs. The spec file defines every endpoint, request parameter, response schema, and authentication method in a single YAML document. Because the format is standardized, a wide ecosystem of tools can work with it:
- Code generation — automatically generate API client libraries in your programming language of choice using tools like OpenAPI Generator or Kiota. This saves you from writing boilerplate HTTP code by hand.
- Testing and exploration — import the spec into tools like Postman, Insomnia, or Bruno to get a ready-made collection of all API endpoints.
- Validation — use the spec to validate your requests and responses during development, catching errors before they reach production.
Need help?
If you have questions about the API or need help with your integration, reach out to us at info@medipim.com. We also provide a sandbox environment where you can test and experiment safely. See the Support & feedback page for more details.