Authentication

This page provides the technical requirements for securely authenticating and interacting with the Skulytics API v3.0.

Obtaining Your API Keys

To interact with the API, you must first retrieve your credentials from the Skulytics dashboard.

  • Location: Log in to the Skulytics Customer Portal.

  • Section: Navigate to the "API Key" section in your profile/settings.

  • Key Types:

    • Public Key: Used for general data retrieval (Products, Brands, Pricing).
    • Secret Key: Required for high-security administrative tasks, specifically managing Sub-Clients.

Supported HTTP Methods

Skulytics v3.0 utilizes standard HTTP verbs to define specific actions. Using the correct method is essential for a successful request.

1. GET (Retrieve & List Data)

The GET method is used exclusively to fetch information from the database.

  • Usage: Use this to List multiple records (e.g., all brands) or Retrieve a single resource (e.g., one specific SKU).
  • Data Transmission: Parameters are passed via the URL (Query String).
  • Security: Typically authenticated using your Public Key.

2. POST (Create & Sub-Client Management)

The POST method is used to send or create new data on the server.

  • Usage: Use this for Creation (e.g., adding a new Sub-Client) or executing Secure Actions.
  • Data Transmission: Data is sent within the Request Body as a JSON object.
  • Security: Requires your Secret Key for administrative endpoints.

How to Use

Include your key in the request header as a Bearer Token.

Header Setup:

  • Key: Authorization
  • Value: Bearer {your_api_key}

Example: Fetching Products (GET)

Use your Public Key to retrieve product data:

curl --request GET \
     --url 'https://api.skulytics.io/v3/e-commerce/product?page=1&per_page=10' \
     --header 'Authorization: Bearer YOUR_PUBLIC_KEY'

Example: Creating a Sub-Client (POST)

Use your Secret Key to add a new sub-client:

curl --request POST \
     --url 'https://api.skulytics.io/v3/customer-portal/sub-client' \
     --header 'Authorization: Bearer YOUR_SECRET_KEY' \
     --header 'Content-Type: application/json' \
     --data '{
        "name": "Authorized Retailer A"
     }'

🚦 HTTP Response Codes

CodeStatusDescription
200SuccessRequest succeeded. Data is returned in the body.
400Bad RequestRequest failed due to invalid input or validation errors.
401UnauthorizedInvalid or missing API Key.
403ForbiddenYou do not have permission to access the requested resource.
404Not FoundThe requested resource (SKU, ID, etc.) does not exist.
500Internal ErrorServer-side error (exception raised).
503Service UnavailableThe server is currently overloaded or down for maintenance.

Support & Key Changes

API Keys cannot be modified directly via the portal. To request a rotation or change of keys, please contact. Skulytics Customer Support : [email protected].