Supply Chain & Retail Solutions user guide

Prerequisites​

• You have curl installed (available by default on Linux, macOS, and Windows 10+).
• You have a tenant API key.
• You have the file ready for upload on your local machine.

Steps using curl​

1. Open a terminal or command prompt.
2. Navigate to the directory containing your file.
3. Generate a signed URL:
   assignment

     curl -X POST "https://api.peak.ai/file/signedurl/client" \
         -H "Content-Type: application/json" \
         -H "Authorization: YOUR_TENANT_API_KEY" \
         -d '{"fileName":"salesrecords20180627121537.csv"}'
     curl -X POST "https://api.peak.ai/file/signedurl/client" \
         -H "Content-Type: application/json" \
         -H "Authorization: YOUR_TENANT_API_KEY" \
         -d '{"fileName":"salesrecords20180627121537.csv"}'
   

4. Copy the signed URL returned in the response body.
   • Signed URLs are valid for 900 seconds (15 minutes). Generate a new URL if the current one expires.
5. Upload the file using a PUT request:
   assignment

   curl -X PUT -H "Content-Type: text/csv" --data-binary "@your-file.csv" "YOUR_SIGNED_URL_HERE"
   curl -X PUT -H "Content-Type: text/csv" --data-binary "@your-file.csv" "YOUR_SIGNED_URL_HERE"
   

6. Verify the response:
   • A successful upload returns a 200 status code.
   • If you see errors, check the response message for details.

Steps using PowerShell (Windows)​

1. Open PowerShell.
2. Navigate to the directory containing your file.
3. Generate a signed URL:
   assignment

   $headers = @{
       "Content-Type" = "application/json"
       "Authorization" = "YOUR_TENANT_API_KEY"
   }
   $body = @{ fileName = "your-file.csv" } | ConvertTo-Json
   $signedUrlResponse = Invoke-RestMethod -Uri "https://api.peak.ai/file/signedurl/client" -Method POST -Headers $headers -Body $body
   $signedUrl = $signedUrlResponse.Trim('"')
   $headers = @{
       "Content-Type" = "application/json"
       "Authorization" = "YOUR_TENANT_API_KEY"
   }
   $body = @{ fileName = "your-file.csv" } | ConvertTo-Json
   $signedUrlResponse = Invoke-RestMethod -Uri "https://api.peak.ai/file/signedurl/client" -Method POST -Headers $headers -Body $body
   $signedUrl = $signedUrlResponse.Trim('"')
   

4. Upload the file:
   assignment

   $headers = @{"Content-Type" = "text/csv"}
   $response = Invoke-WebRequest -Uri $signedUrl -Method PUT -InFile "your-file.csv" -Headers $headers
   Write-Host "Status Code: $($response.StatusCode)"
   $headers = @{"Content-Type" = "text/csv"}
   $response = Invoke-WebRequest -Uri $signedUrl -Method PUT -InFile "your-file.csv" -Headers $headers
   Write-Host "Status Code: $($response.StatusCode)"
   

Result​

Example with verbose output​

curl -X PUT -H "Content-Type: text/csv" --data-binary "@your-file.csv" "YOUR_SIGNED_URL_HERE" -v
curl -X PUT -H "Content-Type: text/csv" --data-binary "@your-file.csv" "YOUR_SIGNED_URL_HERE" -v

• Connection details
• Request headers sent
• Response headers received
• Upload progress

Automating uploads with shell scripts​

#!/bin/bash

# upload_to_peak.sh
SIGNED_URL="$1"
FILE_PATH="$2"

if [ -z "$SIGNED_URL" ] || [ -z "$FILE_PATH" ]; then
    echo "Usage: ./upload_to_peak.sh <signed_url> <file_path>"
    exit 1
fi

if [ ! -f "$FILE_PATH" ]; then
    echo "Error: File not found: $FILE_PATH"
    exit 1
fi

echo "Uploading $FILE_PATH..."
RESPONSE=$(curl -X PUT -H "Content-Type: text/csv" --data-binary "@$FILE_PATH" "$SIGNED_URL" -w "%{http_code}" -o /dev/null -s)

if [ "$RESPONSE" -eq 200 ]; then
    echo "✓ Upload successful"
    exit 0
else
    echo "✗ Upload failed with status code: $RESPONSE"
    exit 1
fi
#!/bin/bash

# upload_to_peak.sh
SIGNED_URL="$1"
FILE_PATH="$2"

if [ -z "$SIGNED_URL" ] || [ -z "$FILE_PATH" ]; then
    echo "Usage: ./upload_to_peak.sh <signed_url> <file_path>"
    exit 1
fi

if [ ! -f "$FILE_PATH" ]; then
    echo "Error: File not found: $FILE_PATH"
    exit 1
fi

echo "Uploading $FILE_PATH..."
RESPONSE=$(curl -X PUT -H "Content-Type: text/csv" --data-binary "@$FILE_PATH" "$SIGNED_URL" -w "%{http_code}" -o /dev/null -s)

if [ "$RESPONSE" -eq 200 ]; then
    echo "✓ Upload successful"
    exit 0
else
    echo "✗ Upload failed with status code: $RESPONSE"
    exit 1
fi

chmod +x upload_to_peak.sh
./upload_to_peak.sh "YOUR_SIGNED_URL" "your-file.csv"
chmod +x upload_to_peak.sh
./upload_to_peak.sh "YOUR_SIGNED_URL" "your-file.csv"

Troubleshooting​

• 401 Unauthorized - Verify that the Authorization header contains a valid tenant API key when generating the signed URL.
• 403 Forbidden - The signed URL may have expired. Request a new signed URL.
• 400 Bad Request (invalid file extension) - Use a supported extension such as .gz, .csv, .txt, .json, or .xml.
• 400 Bad Request (invalid filename) - Verify that the file name follows Peak naming rules.
• HTTP/1.1 100 Continue - This can appear while the file is still uploading. Wait for the final response status.
• curl: command not found - Install curl or use PowerShell on Windows.
• Failed to open file - Check that the file path is correct and you have read permissions.