Premise
On Poleepo you can generate API keys to use Poleepo APIs and automate many processes (from product publishing to order retrieval) or you can generate API keys to make custom integrations.
You can consult the Poleepo API documentation at this link:
Configure API
To start configuring API keys, follow the path Configurations > API
In this section you can create API keys and Webhooks, manage login credentials and configured Webhooks.
Remember that this is sensitive data , share this data only with people you trust.
1. Creating API Keys
To create your API keys, click on the "API Keys" drop-down at the top and then on "create key" at the bottom right.
From here you can create a new login credential for applications external to Poleepo. Remember that these applications can access your data , give these credentials only to applications you trust.
First, give a name to the API Key you want to create;
Enter the email of a technical contact that our support can contact in case of problems or new features for the API;
Choose the permissions you want to give to the Key;
Supplier
For example, by choosing the supplier you will indicate which information the key will have access to (if selected the supplier will not be able to view data from other suppliers)
Orders
Choose the type of access you want to give the key (no access, write or read) to the order list, order status and inventory assignment.
Then indicate the data not to be displayed on exit (sensitive customer information or order prices)
Products
Choose the type of access you want to give to the key (no access, write or read) to the product list, create new products, update product data. Create and edit publication data.
Shipping
Choose the type of access you want to give to the key (no access, write or read) to the list of shipments, create new shipments, update shipment data. Create and modify and download courier waybills.
Finally click on " Save " to save the key you just created.
Once saved, the system will generate a pair of keys (one public and one private) that you will have to copy and keep safe , especially the private one which will no longer be visible once the alert is closed.
Enable the newly created key
Enable the newly created key to make it functional by checking the " activate " button at the top right .
You can view, activate, delete or modify the keys you have created by returning to the main screen, where there will be a list with the information of all the keys you have generated.
2. Webhooks Creation
To create a Webhook instead, select the item in the drop-down menu at the top and then click on " create Webhook "
To create a new Webhook (remember that these applications can access your data , only give this data to applications you trust)
give a name to the configuration;
enter the email of a technical contact that our support can contact in case of problems or new features for Webhooks;
enter the configured URL;
select a value from the list of permissions to give;
Finally click on " save " to save the Webhook you just created.
Once saved, the system will generate a secret key to copy and keep safe. Remember that you will be able to view the private key again in the Webhook detail.
Enable the newly created Webhook
Enable the newly created Webhook by checking the " activate " button at the top right .
You can view, activate, delete or edit the Webhooks you have created by returning to the main screen, where you will have a list with information about all the Webhooks you have generated.
