How to create a Maropost (Neto) API key for Zendesk
By Jake Marsh · Updated
To connect a Maropost Commerce Cloud (Neto) store to Zendesk, add a staff user for Zendesk in the Maropost control panel, give it a permission group that can view orders, customers and returns, and generate a user-based API key on that user. In Postiewell's settings, enter your store domain (like www.yourstore.com.au), the staff user's username as API username and the key as API key. Zendesk stores the key as a secure setting agents never see.
Why a user-based key
Maropost recommends a user-based API key over the global key: it is tied to one staff user, limited by that user's permission group, and you can revoke it without touching anything else. Postiewell sends it in the NETOAPI_KEY header only to your store domain.
Steps
- Add a staff user. In the Maropost control panel, add a staff user for Zendesk (Maropost's help article "Add a staff user account").
- Give it a permission group. Use a group (Maropost's help article "Set up staff permission groups") that can view orders, customers and returns. If agents will add sticky notes or change statuses, it also needs to update orders.
- Generate the API key on that staff user. Keep it in Zendesk only.
- Install Postiewell from the Zendesk Marketplace and start the 14-day trial.
- Fill in the settings (table below) and save.
- Test it. Open a ticket from a customer with orders. Their orders should appear in the sidebar.
Settings
| Setting | What to enter |
|---|---|
| Store domain | Your webstore's domain in lowercase, like www.yourstore.com.au, without https:// or a slash. Zendesk only sends the key to this exact domain. |
| API username | The staff user's username |
| API key | The key generated on that user |
| Store currency | The currency your prices are in (default AUD). Maropost orders don't say their currency, so Postiewell uses this for every amount. |
| Store label | The name agents see (default: Maropost) |
| Brands for this store | Zendesk brand ids whose tickets open this store first |
| Stores 2 and 3 | Fill in a store domain to turn one on, then its username, key and currency |
Which permissions you need
| What agents do | Permission group needs |
|---|---|
| See orders, customers, tracking and returns | View orders, customers and returns |
| Add sticky note | Also update orders |
| Change status | Also update orders, plus Allow status changes on in Postiewell |
Errors and fixes
| Message | Fix |
|---|---|
| Maropost didn't accept the API username and key | Check the username and generate a new key on the staff user; check its permission group. |
| No Maropost API at the store domain | The store domain is wrong or points elsewhere. Use your webstore's own domain. |
| Zendesk refused the request (HTTP 403) | The store domain setting doesn't match the domain the app calls, or the key is missing. Re-enter both. |
| "isn't usable as the store domain" | Remove https://, any slash or capitals. |
Add an Open in Maropost link
Open any order in your control panel, copy the address after your domain and put {id} where the order number is, for example /_cpanel/order/vieworder?id={id}. Postiewell adds your store's domain.
What it costs
Postiewell is US$9 a month per agent, billed monthly by Zendesk, with a 14-day free trial (Zendesk asks for a card at install). Nothing is created in Zendesk at install. The Postiewell documentation has the full reference.
Postiewell
Maropost (Neto) orders sidebar: orders, tracking and returns, found by email. US$9/agent. $9 a month per agent.
Questions
Should I use the global API key or a user-based key?
Use a user-based key on a dedicated staff user. Maropost recommends it because you can limit it with a permission group and revoke it on its own, and Postiewell's setup is written for it.
Do I need OAuth or a Maropost add-on listing?
No. Postiewell uses an API key from a staff user, the method Maropost documents for custom integrations.
Can I connect my Australian and New Zealand stores?
Yes, up to three stores, each with its own domain, key, currency and Zendesk brands.
How do I cut off access?
Uninstall Postiewell, which removes the key from Zendesk, and delete the staff user or its key in Maropost.