Gigrove¶
The Gigrove modules allow you to monitor the orders in your Gigrove account.
Getting Started with Gigrove¶
Prerequisites
- A Gigrove account
In order to use Gigrove with Ibexa Connect, it is necessary to have a Gigrove account. If you do not have one, you can create a Gigrove account at gigrove.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Gigrove to Ibexa Connect¶
To connect your Gigrove account to Ibexa Connect you need to obtain the API Key and API Secret from your Gigrove account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your Gigrove account.
2. From the left menu, click API > Download my API Keys.
3. Copy the API Key and API Secret details to a safe place.
4. Go to Ibexa Connect and open the Gigrove module's Create a connection dialog.
5. In the API Key and API Secret fields, enter the details copied in step 3 respectively and click Continue.
The connection has been established.
Triggers¶
Watch Orders¶
Triggers when a new order is created.
| Limit | Set the maximum number of orders Ibexa Connect should return during one scenario execution cycle. |
Actions¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Gigrove API Documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Orders¶
The following API call returns all the orders from your Gigrove account:
URL: /v1/orders
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. In our example, 3 orders were returned:
