TextYess connects to your Magento store over the Magento REST API. Rather than reusing a top-level admin account, we recommend creating a dedicated admin user whose role grants only the resources TextYess needs to read your catalog, orders and customer groups. The whole process takes about ten minutes in your Magento admin, followed by a single form in the TextYess dashboard.Documentation Index
Fetch the complete documentation index at: https://docs.textyess.com/llms.txt
Use this file to discover all available pages before exploring further.
Step 1: Create a TextYess role
In your Magento admin, go to System → Permissions → User Roles, then click Add New Role. You’ll name the role, set its resource access to Custom, and tick exactly the permissions listed in the table below.| Purpose | Magento admin path | ACL resource id |
|---|---|---|
| Read product catalog | Catalog → Inventory → Products | Magento_Catalog::products |
| Read categories | Catalog → Inventory → Categories | Magento_Catalog::categories |
| Read stock levels | Stores → Inventory → Stocks | Magento_InventorySalesApi::stock |
| Read orders | Sales → Operations → Orders | Magento_Sales::sales |
| View order detail | Sales → Operations → Actions → View | Magento_Sales::actions_view |
| Read customers | Customers → All Customers | Magento_Customer::manage |
| Read customer groups | Customers → Customer Groups | Magento_Customer::group |
| Read store config (health check) | Stores → Settings → All Stores | Magento_Backend::store |
The hint shown next to the credentials form in the TextYess dashboard currently lists only a subset of these resources. The table above is the authoritative list — a merchant who assigns only the shorter list will see 401/403 errors on the first catalog or customer sync. We’re updating the dashboard hint in a future release.
Name the role
Under Role Info, set Role Name to
TextYess Integration. When prompted, enter your current admin password to confirm the role change.Set resource access to Custom
Open the Role Resources tab. Set Resource Access to Custom — this reveals the full permission tree.
Tick the required resources
Check every resource listed in the table above and nothing else. The Magento admin path column shows where each resource lives in the tree; the ACL resource id column is the internal identifier your sysadmin or hosting provider can cross-reference.
Step 2: Create a dedicated admin user
Still under System → Permissions, open All Users and click Add New User.Fill in Account Information
Use a username that makes the integration easy to recognise later, for example
textyess. Provide a contact email and a password (with confirmation).Assign the TextYess Integration role
Open the User Role tab and select the
TextYess Integration role you created in Step 1. Without this step the user will have no permissions at all.Step 3: Enter your store URL in the TextYess dashboard
Open the Connect Your Magento Store page in the TextYess dashboard. Paste the public storefront URL of your shop — for example,https://your-store.com — into the Shop URL field.
Use the storefront origin, not your Magento admin URL. Many stores harden their admin with a non-default path such as
https://your-store.com/admin_7f2a; you still enter https://your-store.com here. TextYess calls Magento’s REST API under /rest/V1/... at the storefront origin.Step 4: Enter the new user’s credentials and connect
Paste the Username and Password you set in Step 2 into the corresponding fields, then click Connect Magento.Your store is now connected. TextYess will start importing your product catalog, categories, customer groups and recent orders automatically. Large catalogs can take several minutes to finish the first sync.
Having trouble? Reach out to TextYess Support with your store URL and a short description of the problem.