Helcim API Connection
Prepare Helcim Account ID and API Token for a Next-Cart migration service when API setup is shown for Helcim.
Helcim API Connection
Section titled “Helcim API Connection”A valid Helcim API connection gives Next-Cart the authorized platform access required by the selected migration path.
Next-Cart may ask for your Helcim Store URL, Account ID, and API Token. Prepare the values in Helcim first, then enter them in the Next-Cart connection setup screen.
When to use this guide
Section titled “When to use this guide”Use this guide when:
- Helcim is the Source Platform or Target Platform in your selected migration path;
- Next-Cart shows Helcim API setup;
- you have permission to create or manage API access in Helcim.
Prerequisites
Section titled “Prerequisites”Before you begin, confirm that:
| Requirement | Why it matters |
|---|---|
| Helcim admin access | You need access to account and integration settings. |
| Permission to create API access | API tokens are created from Helcim integration settings. |
| Account ID access | Next-Cart may require the Helcim Account ID. |
| Data scope is known | API permissions should match the data included in the migration scope. |
| Secure storage | API tokens should be copied and stored safely. |
Required values
Section titled “Required values”| Required value | Where to prepare it | Notes |
|---|---|---|
| Store URL | Helcim store or account URL | Use the value requested by Next-Cart. |
| Account ID | Helcim account information | Copy the account identifier shown in Helcim. |
| API Token | Helcim API Access configuration | Copy the generated token after creating API access. |
Prepare Helcim API values
Section titled “Prepare Helcim API values”- Sign in to Helcim.
- Open All Tools.
- Go to Settings.
- Open My Account.
- Copy the Account ID from the merchant or account information area.
- Return to All Tools.
- Open Integrations.
- Open API Access Configurations.
- Open Legacy API Access if that is the access type shown in your Helcim account.
- Create a new API access configuration.
- Use a clear name, such as
Next-Cart Migration. - Mark the access as active.
- Grant view permissions for the data types included in the migration scope.
- Save the configuration.
- Copy the generated API Token and store it securely.
Enter the values in Next-Cart
Section titled “Enter the values in Next-Cart”In the Next-Cart connection setup screen for Helcim, enter the values requested by the interface.
| Next-Cart field | Helcim value |
|---|---|
| Store URL | Helcim store or account URL requested by Next-Cart. |
| Account ID | Account ID from Helcim account information. |
| API Token | Generated API Token from API access settings. |
Expected result
Section titled “Expected result”The Helcim API values are ready to test in Next-Cart.
Verify the connection
Section titled “Verify the connection”| Check | Pass condition |
|---|---|
| Account ID | The Account ID belongs to the intended Helcim account. |
| Token status | The API Token is active. |
| Permissions | The API access can read the data types included in the migration scope. |
| Store match | The values belong to the intended Helcim store or account. |
If the connection fails
Section titled “If the connection fails”| Issue | What to check |
|---|---|
| Account ID rejected | Re-copy the Account ID from Helcim account information. |
| Token rejected | Re-copy the API Token or create a fresh API access configuration. |
| Token inactive | Confirm the API access configuration is active. |
| Missing permission | Add the required view permissions for the data in scope. |
| Wrong account | Confirm you created the token in the Helcim account used for the migration path. |
Security cleanup
Section titled “Security cleanup”After migration work is complete and verified:
- disable or delete the API access configuration if it is no longer needed;
- rotate exposed tokens;
- remove copied credentials from shared notes, tickets, or local files that are no longer needed.
Next step
Section titled “Next step”| Goal | Go to |
|---|---|
| Test the connection | Verify Platform Connections |
| Fix an API token or permission issue | Troubleshoot Connection Setup |
| Continue after the connection passes | Configure Your Migration |