stagingpro-api.vortexiq.ai Open in urlscan Pro
44.196.212.198  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



StagingPro API - Documentation
Introduction
Authenticate
Bulk Content Migration
Product Migration
Promotion Migration
Category Migration
Theme Migration
Page / Template Migration


STAGINGPRO API - DOCUMENTATION


AUTHORIZATIONBearer Token
Token

<token>


AUTHENTICATE

Authenticate (POST):
This API authenticates the user by submitting an access key, secret key, and
store ID. On success, it returns a token that is required for other
authenticated requests.

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionStagingPro API - Documentation



POSTAUTHENTICATE


https://api.stagingpro.com/v1/api/Login


LOGIN API

This API endpoint is used to authenticate and login a user with the provided
access and secret keys.

REQUEST

   

 * Method: POST

   

 * Endpoint: https://api.stagingpro.com/v1/api/Login

   

 * Headers: No specific headers required

   

 * { "AccessKey": "DG56HY*E475RGH6HYR", "SecretKey": "Usdh358yfeh***3593uE",
   "StoreId": "ydizsnqpq3"}

   

RESPONSE

Upon a successful login, the API returns the following response:

json


{
    "Status": "",
    "StatusComment": "",
    "CustomerId": 0,
    "UserToken": ""
  }

   

 * Status: The status of the login request.

   

 * StatusComment: Additional comment or message related to the status.

   

 * CustomerId: The unique identifier of the customer after successful login.

   

 * UserToken: Token generated for the authenticated user.

   

This API endpoint allows users to authenticate and obtain a user token for
accessing the system.

REQUEST BODY

   

 * AccessKey (text, required): The access key for authentication.

   

 * SecretKey (text, required): The secret key for authentication.

   

 * StoreId (text, required): The ID of the store.

   

RESPONSE BODY

The response is in JSON format and includes the following fields:

   

 * Status (string): The status of the login request.

   

 * StatusComment (string): Additional comments related to the status.

   

 * CustomerId (integer): The ID of the customer.

   

 * UserToken (string): The token for the authenticated user.

   

JSON SCHEMA

json


{
  "type": "object",
  "properties": {
    "Status": { "type": "string" },
    "StatusComment": { "type": "string" },
    "CustomerId": { "type": "integer" },
    "UserToken": { "type": "string" }
  }
}

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionStagingPro API - Documentation
HEADERS
Accept

*/*

Content-Type

application/json

Bodyraw

{
    "AccessKey": "DG56HY**********E475RGH6HYR",
    "SecretKey": "Usdh358yfeh************3593uE",
    "StoreId": "ydizsnqpq3"
}

Example Request
Response_200

curl


curl --location 'https://api.stagingpro.com/v1/api/Login' \
--header 'Accept: */*' \
--header 'Content-Type: application/json' \
--data '{
  "AccessKey": "WN*************4X",
  "SecretKey": "vS3y3***********************dtCeF"
}'

Example Response
 * Body
 * Headers (0)

View More
Text


{
  "Status": "Success",
  "StatusComment": "Success",
  "CustomerId": 1,
  "UserToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IlN0YWdpbmdQcm8iLCJQcm9kdWN0aW9uU3Rvc***********mNvbSJ9._ATneo********Kri3hg"
}

No response headers
This request doesn't return any response headers
BULK CONTENT MIGRATION

Get Store Data Summary (GET):
Retrieves a summary of store data, including counts of pages, widgets, banners,
abandoned cart email templates, products, and other store-related entities.

Get Data Migration Status (GET):
Checks the status of the migration process for a store's data. It returns
progress details, such as the percentage completed and current status of the
migration.

Get Data Migration Entity Status (GET):
Fetches the migration status of individual entities (e.g., brands, categories,
products) during a store migration process. It includes source and destination
counts for each entity.

Migrate Store Data (POST):
Initiates the migration of store data from one store to another. The request
specifies the entities to be migrated, whether to remove existing data in the
destination, and migration credentials for both source and destination stores.

Get Entity Errors (GET):
Retrieves any errors encountered during the migration of specific entities
(e.g., CustomerGroups) between stores. This includes details about conflicts or
other migration issues.

Cancel Data Migration Request (POST):
Cancels a scheduled migration request. The request needs the migration ID and
destination store ID, and on success, it confirms that the migration request has
been canceled.

Get Data Migration History Report (GET):
Generates a report of past migration history for a store, including details of
each migration, such as status, comments, scheduled time, and entity types
involved.

Get Scheduled Migration Data Requests (GET):
Returns any scheduled migration requests for the specified destination store,
including migration details such as the entities involved and the scheduled
date.

Get In Progress Content Migration (GET):
Retrieves the current status of content migration, indicating if any migration
tasks are in progress.

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionStagingPro API - Documentation