Import

Create a mapper

Create a new mapper attached to an application. The mapper name must be unique within the application.

post/v1/import/mappers

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/import/mappers
  • Auth: API key in header X-Api-Key

Request body

string required

Response

ImportMapper created successfully

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

applicationstring uuid required

UUID of the parent application owning the mapper.

namestring required

Human-readable mapper name. Must be unique within the parent application.

type'file' | 'url' required

How the data is obtained: file (manual upload at import time) or url (file fetched on a recurring CRON schedule).

urlstring uri nullable required

Absolute URL of the file fetched on each scheduled run. Null unless type=url.

cronFrequencystring nullable required

CRON expression driving the scheduled fetch. Null unless type=url.

csvHasHeaderboolean nullable required

Scheduled CSV sources only: whether the first fetched row is a header to skip (true) or already data (false). Null for file mappers and ignored when the fetched file is JSON.

Example response

{
  "application": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Shopify product import",
  "type": "file",
  "url": "https://example.com/catalog/products.csv",
  "cronFrequency": "0 2 * * *",
  "csvHasHeader": true,
  "rows": [
    {
      "type": "path",
      "source": "$.product.brand",
      "destination": "brand"
    }
  ],
  "sourceStructure": {
    "format": "csv",
    "columns": [
      "gtin",
      "titre",
      "prixttc"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.