> ## Documentation Index
> Fetch the complete documentation index at: https://api.basetools.cz/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecting as a partner platform (Shops API)

> How e-commerce platforms can offer integration with Base.com

## What this is

The Shops API is for e-commerce platform operators (not individual stores) who want to offer their clients an official Base.com integration. Unlike the main API, here **Base.com calls a file hosted on your server**, rather than the other way around.

## How it works

1. On your server, you build a publicly reachable script (usually PHP, but any language works) that accepts POST requests with an `action` parameter (the function name) and `bl_pass` (a communication key generated in the Base.com panel).
2. Base.com never sends or requires any passwords or database access — communication is secured only by a randomly generated key.
3. Results are always returned as UTF-8 JSON.

## Required methods

Without these two, the integration cannot be activated:

* `SupportedMethods` — list of functions your integration file supports.
* `FileVersion` — your integration file's version.

## Recommended implementation order

1. `SupportedMethods`, `FileVersion` — the baseline required for verification.
2. `ProductsCategories`, `ProductsList`, `ProductsData` — reading the catalog.
3. `ProductsPrices`, `ProductsQuantity` — prices and availability.
4. `OrdersGet`, `StatusesList`, `DeliveryMethodsList`, `PaymentMethodsList` — reading orders and reference lists.
5. `OrderAdd`, `OrderUpdate` — writing orders back into your platform.
6. Optionally `ProductAdd`, `CategoryAdd`, `ProductsQuantityUpdate`, `ProductsPriceUpdate` for two-way catalog management.

Full parameter and response details for each method are in the [Shops API documentation](https://developers.baselinker.com/shops_api/).

## Pagination

If a method (typically `ProductsList`, `ProductsQuantity`, `ProductsPrices`) can return large volumes of data, include a `pages` field with the total page count in the response. Base.com will then request pages 2 through N via the `page` parameter.

<Tip>
  If you're planning to offer this integration to a broader set of clients (partner program), we recommend reviewing the implementation with our implementation team before going live — they'll check completeness and performance of the integration file.
</Tip>