LogoLogo
  • General
    • Overview
    • Mode of Operation
    • Key Services and Logistics Requirements
  • Know Your Customer (KYC) FAQs
  • User Guide
    • General Product Information
    • Create Products
    • Product Image Requirements
    • Manage and Publish Products
    • Manage Stock and Prices
    • Orders and Shipments
    • User Management
  • API
    • Getting Started
      • API Authentication
      • Sandbox Environment
      • Make your first API request
    • Products
      • Get Products
      • Create and Update Products
      • Get Product Batch Results
      • Update Product Status (and Publish)
      • Get Product Status Update Batch Results
      • List Product Categories
      • List Product Attribute Groups
    • Stock and Prices
      • Update Stock
      • Get Stock Batch Results
      • Update Price
      • Get Price Batch Results
    • Orders and Shipment
      • Get Orders
      • Ship Order Items
      • Get Shipped Order Batch Results
      • Cancel Order Items
      • Get Cancelled Order Item Batch Results
      • Return Order Items
      • Get Returned Order Batch Results
    • Webhooks
      • Order Delegation Webhook
  • Shopify Plugin
    • Getting Started
      • Intro
      • Add Custom App to your Store
      • Sync your Shop in the Sellers Center
      • Product Preparations
      • Sync Products
      • Connect Products to the Seller Center
    • Order Handling
    • Additional Information
      • Permissions
      • Stock Safety Margin
      • Price Markup
On this page

Was this helpful?

Export as PDF
  1. API
  2. Getting Started

API Authentication

PreviousGetting StartedNextSandbox Environment

Last updated 1 month ago

Was this helpful?

Our API uses API Key authentication to ensure secure access. Only Admin users can generate API keys, while Member users do not have permission to create or manage keys. This ensures that only authorized users can access and integrate the API.

Generating an API Key

To obtain an API key:

  1. Navigate to Settings in the UI.

  2. Go to the API Keys section.

  3. Click + Add.

  4. Input a label for the key, optionally set an expiration date and click Add Key.

  5. Copy and securely store the key, as it will not be shown again.

Using the API Key

Once you have generated an API key, include it in the request header for authentication:

X-API-Key: YOUR_API_KEY

Example request using curl:

curl -X GET "https://partner.aboutyou.com/api/v1/products" \
     -H "X-API-Key: YOUR_API_KEY"
API Keys settings section