EKM API Connection

EKM API Connection

Authorize the EKM Online Store Migration app, obtain the EKM API Key, and prepare the EKM Source API connection. File Upload remains the standard EKM Source connection method; the API path is used when it is included in the migration project.

Get the connection details

Before you begin, confirm that the EKM account can authorize an application for the intended Source Store and that you are working with the store included in the migration project.

EKM API project scope

EKM API access is handled through Custom Migration. When API access is required, the customer and Next-Cart discuss the requirements, constraints, responsibilities, and technical feasibility until the scope is mutually agreed. Self-Execute and Expert Handle remain distinct execution models within that scope.

1. Open the EKM authorization page.
2. Sign in to the intended EKM account and review the application-access request.
3. Select Allow to authorize the Online Store Migration app.
4. When authorization succeeds, copy the displayed EKM API Key. Download a copy only when the project requires a retained credential record.

Treat the EKM API Key as a sensitive credential. Do not publish it in screenshots, shared documents, Support Tickets, or public messages. If exposure is suspected, stop using the key and follow the project support path before continuing.

Enter the values in Next-Cart

The normal EKM Source setup in the Connect Stores step uses File Upload and does not expose an API credential field. When the mutually agreed EKM API setup is enabled for the project, use the project-specific API connection entry supplied for that scope.

Next-Cart field	Value to enter
EKM API Key	The key returned after authorizing the Online Store Migration app for the intended EKM store.

• Self-Execute: enter the EKM API Key through the project-specific EKM API setup provided for the agreed scope, then continue with the connection verification step supplied for that setup.
• Expert Handle: keep the authorized key available through the secure project workflow; Next-Cart technical specialists perform the agreed API connection setup and verification.

Do not substitute a key from another EKM account, another store, or an unrelated migration.

Verify this connection

Confirm that the EKM API setup resolves to the intended Source Store and that the authorization is usable for the agreed scope.

Check	Pass condition
Store identity	The authorized EKM account is the Source Store included in the migration project.
Authorization	The Online Store Migration app authorization completes without an error.
API Key	The EKM API Key is accepted by the project-specific EKM API connection setup.
Scope	The connection method matches the mutually agreed Custom Migration scope and execution responsibility.

When the project-specific setup provides Test Connection, use it as the optional connection check. A successful test shows Connected. A failed test shows Not connected; use the checks below before continuing. For Expert Handle, the assigned technical specialists perform the connection verification within the agreed scope.

A Connected result confirms that the project-specific setup can use the authorized EKM connection values. It does not confirm migration configuration, mappings, or final migrated data; validate those separately during the Configuration step and post-migration review.

If the connection does not pass

Issue	What to check
Authorization page does not complete	Confirm that you are signed in to the intended EKM account and that the account can authorize the app.
Wrong EKM store was authorized	Stop before migration processing and repeat authorization with the store included in the project.
No API Key is returned	Do not substitute another credential. Recheck the authorization flow and use the project support channel if the key is still unavailable.
API Key is rejected by the project setup	Confirm that the key belongs to the intended EKM store and has not been replaced, exposed, or revoked. Use the project support channel if the connection still does not pass.
EKM API is not included in the agreed project scope	Use EKM Source Data Export and the standard File Upload workflow, or discuss the required EKM API Custom Migration scope with Next-Cart.