Skip to content

Quick Start

CLI Usage

  1. Create a config.yaml file:
source:
  type: rest
  base_url: https://api.example.com
  endpoints:
    list: { path: /items, method: GET }
target:
  type: rest
  base_url: https://api.dest.com
  endpoints:
    create: { path: /items, method: POST }
mapping:
  - source: list
    target: create
    fields:
      - { source: id, target: external_id }
  1. Run the sync:
apilinker sync --config config.yaml

Python Usage

from apilinker import ApiLinker

linker = ApiLinker()
linker.add_source(type="rest", base_url="...")
linker.add_target(type="rest", base_url="...")
linker.sync()