Supply Chain & Retail Solutions user guide

Prerequisites​

• You have access to Peak with permissions to configure Data Sources.
• You have the REST API endpoint URL and any required authentication credentials.

Configuring the connection​

1. In Peak, open Manage and select Data Sources.
2. Select Add feed and choose the REST API connector.
3. At the Connection stage, either select an existing connection from the dropdown or select New connection.
4. For a new connection, enter the connection parameters. See Connection parameters.
5. Select Save and proceed to the next stage.

Connection parameters​

Authentication types​

Configuring import settings​

Installing dependencies​

Writing the fetch script​

• outputStream.write(obj): Writes a record to the feed output. Call this for each record you want to ingest.
• metadata.save(object): Saves feed run details (for example, a timestamp or offset) so they can be used on the next run to fetch data incrementally. metadata starts as an empty object {}.

import requests
from lib import outputStream, metadata
import requests
from lib import outputStream, metadata

Previewing results​

• JSON: The data as received from the API.
• Tabular: The data in a table format.

Load type and feed name​

• Load type: Always Incremental.
• Feed name: Use only alphanumeric characters and underscores. Must start with a letter, must not end with an underscore, maximum 50 characters.

Configuring the destination​

• Redshift: Redshift and S3
• Snowflake: Snowflake only

Configuring the trigger​

Result​