Integration
Marketplace API connection details, creating API users, revealing and deleting secrets, sample requests in four languages.
The Integration screen provides everything you need to connect your own system (ERP, integrator software, or a custom application) to the marketplace API in one place: API base URL, your vendor number, API users' key and secret information, API documentation, and ready-made sample requests in four programming languages. Vendors and their software teams who want to automatically transfer their products and orders without using the panel use this screen.
Accessing the screen
Select Vendor Panel › Support › Integration from the left menu.
If you do not see it in the menu, your account does not have permission for this screen. If your account is not linked to a vendor, the screen will display the warning "Integration is exclusive to vendor accounts"; API users are managed only with a vendor account.
Screen sections
- Title — Integration with the description API users, connection details, and sample requests to connect to the marketplace API. below.
- Connection details card — API base URL, your vendor number, and authentication method.
- Documentation card — Links to API documentation.
- API users (N/N) card — List of your created API users and management buttons.
- Sample requests card — Copyable code samples based on the selected request and language.
Connection details
| Field | Meaning |
|---|---|
| API base URL | The base address of the marketplace API your integration will send requests to. Click the Copy icon next to it to copy to clipboard. If not defined, it shows API base URL is not defined for this setup; request from support team. |
| Vendor no | Your vendor account number. Click the Copy icon to copy it to clipboard. |
| Authentication | The method used by the API: Basic Auth: write "Basic " + base64(API key:API secret) in the Authorization header. That is, for each request, combine the API key and secret with a colon, encode in base64, and put it in the Authorization header. |
When copying succeeds, a Copied notification appears; if the browser does not allow clipboard writing, a Something went wrong notification appears.
Documentation
The Documentation card states All endpoints, fields and error codes are in the API document. The card contains these buttons (each opens in a new tab):
- Turkish document and English document — PDF versions of the API documentation. If no document is defined for your setup, these buttons do not appear.
- docs.hebiar.com — Online documentation site.
API users
The card header shows how many API users you have and the maximum allowed (e.g., "API users (2/5)"). You can create up to 5 API users. Below the header is the note: It is recommended to create a separate user for each integration (ERP, integrator); if one is compromised, you only delete that one.
Each row shows:
| Field | Meaning |
|---|---|
| API key | The user's key (used instead of username). Click the Copy icon to copy it to clipboard. |
| API secret | The user's secret key. For security, only the last four characters are visible in the list (e.g., •••• a1b2); the full secret is revealed only by clicking Reveal secret. |
| Supplier id | The supplier number used in API request URLs. Visible only if defined. |
If you have not created any users yet, the card shows You have no API users yet and Create a new API user to start integration.
Management operations (new user, reveal secret, delete) require separate permission. If you do not have this permission, the New API user, Reveal secret, and delete icons do not appear; you can only view the information.
Operations
Creating a new API user
Use this when setting up a new integration or when you suspect a key has been compromised and want to change it.
- Click the New API user button in the "API users" card.
- Read the warning in the popup: "A new API key and secret will be generated. Up to 5 users can be created. Secret is shown only once."
- Click Create.
- In the API user created window, the new user's API key and API secret appear. Copy each using the Copy icon and save securely (e.g., password manager).
- Close the window by clicking I saved it.
The popup warns: Save the secret securely now. Do not share it via email or message. The new user is added to the list. Although the confirmation states the secret is shown only once, if you have management permission, you can later reveal the secret again from the list using Reveal secret; however, saving it in this popup is the safest way. In some cases, the secret cannot be shown in this popup; then a notification API user created; you can view the secret from the list. appears, and you retrieve the secret via Reveal secret in the list.
When you reach 5 users, the New API user button becomes inactive; hovering over it shows "Up to 5 API users can be created; delete one to add a new one." If creation fails, a red error box appears (e.g., The API user could not be created.).
Revealing and copying the secret
- Click the eye icon (Reveal secret) next to the API secret field of the relevant user in the list.
- The full secret appears with a Copy icon.
- When done, click the Hide icon to conceal the secret.
The revealed secret automatically hides after 60 seconds; a note appears below the card: "Revealed secret will automatically hide after 60 seconds." If you open secrets for multiple users, all hide together 60 seconds after your last show/hide action. If the secret cannot be retrieved, a red error notification appears. Do not show the secret during screen sharing or in environments visible to others.
Deleting an API user
Use this to revoke unused or suspicious keys.
- Click the trash icon (Delete API user) on the right of the row.
- Read the warning in the popup: … will be deleted. Integrations using this key will stop immediately.
- Click Delete.
After deletion, a API user deleted notification appears and the list refreshes. Deletion is irreversible; integrations using this key must be reconfigured with a new user. To avoid interruption, create a new user and update the integration before deleting. If deletion fails, an error like The API user could not be deleted. appears.
Getting sample requests
The Sample requests card generates ready-to-use code to quickly test your integration (Copy to Postman or your code. Placeholders are used by default.).
- Select cURL, JavaScript, C#, or Python from the language dropdown at the top right.
- Choose a request from the list:
- Create products — Sample request with a product body to send products.
- Batch status — Query the processing status of a sent product batch.
- Get order packages — Retrieve your order packages.
- If you have multiple API users, select the API key to use in the sample from the second list.
- Click the Copy button at the top right of the code to copy the sample.
The sample includes the API base URL and the selected user's supplier id filled in; credentials appear as placeholders (e.g., {BASE64(API_KEY:API_SECRET)}). Replace placeholders like {BATCH_ID} in the Batch status example with your own values; field details are in the API documentation. If the API base URL or supplier id is not defined, placeholders {BASE_URL} and {SUPPLIER_ID} appear instead.
The Fill with my real credentials checkbox inserts the selected user's real key and secret into the sample:
- To enable the checkbox, you must first reveal that user's secret with Reveal secret. If not revealed, the checkbox is disabled with the note Reveal the secret first to fill in real credentials next to it.
- When checked, a warning Sample contains live credentials appears next to the example. Do not share this example or paste it into support requests or emails.
- When the secret hides after 60 seconds, the sample reverts to placeholders.
Common situations
- "API base URL is not defined for this setup" is shown instead of the API base URL. The marketplace API address has not been assigned for you yet. Open a request with the operator from the Support requests screen.
- The "New API user" button is inactive. You have reached the limit of 5 users. Delete an unused user and try again.
- New API user, reveal, and delete buttons are missing. Your account lacks permission to manage API users; you can only view information.
- I forgot to save the secret. If you have management permission, you can reveal and copy it again from the list using Reveal secret.
- My integration suddenly stopped working. The API user it used may have been deleted; integrations using deleted keys stop immediately. Check if the key still appears in the list; if not, create a new user and update the integration.
- The screen does not open, an error box appears. Click Retry. If the problem persists, share the text in the Technical detail section with the support team.
Related screens
- My products — Monitor products sent via API from the panel.
- Bulk product operations — Bulk product and stock transfer via Excel instead of API.
- My orders — Panel view of order packages retrieved via API.
- Support requests — Send your integration questions to the operator.