Modules

All endpoints that are created for managing modules

Get all base modules

GET https://dev.bol.mintycloud.nl/api/v1/modules

This endpoint gets all base modules

200: OK Base modules

[
    {
        "identifier": "bol.mintyconnect.order.wachtagent",
        "name": "Order Wachtagent plugin",
        "description": "Deze plugin biedt de mogelijkheid om bestellingen van Bol naar WooCommerce te verzenden.",
        "enabled": 1,
        "isBase": 1,
        "users": " []",
        "possibleSettings": "{\"phone\": \"\", \"email\": \"\", status: \"default\" }"
    },
    {
        "identifier": "bol.mintyconnect.product.wachtagent",
        "name": "Product wachtagent plugin",
        "description": "Deze plugin biedt de mogelijkheid om product data bij te houden tussen bol en woocommerce.",
        "enabled": 1,
        "isBase": 1,
        "users": "",
        "possibleSettings": "{\"stockSync\":true,\"priceSync\":false}"
    }
]

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Failed to add account"
}

Get specific base module

GET https://dev.bol.mintycloud.nl/api/v1/modules

This endpoint gets specific base module

Path Parameters

Name	Type	Description
identifier*	String	module identifier

200: OK Get specific base module

{
    "identifier": "bol.mintyconnect.order.wachtagent",
    "name": "Order Wachtagent plugin",
    "description": "Deze plugin biedt de mogelijkheid om bestellingen van Bol naar WooCommerce te verzenden.",
    "enabled": 1,
    "isBase": 1,
    "users": " []",
    "possibleSettings": "{\"phone\": \"\", \"email\": \"\", status: \"default\" }"
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Failed to add account"
}

Create a new module

POST https://dev.bol.mintycloud.nl/api/v1/modules

This endpoint creates a new base module

Request Body

Name	Type	Description
identifier*	String
name*	String
settings	Object
users	Array
isBase*	Boolean
enabled*	Boolean
description*	String

200: OK Created successfully module

{
    "identifier": "bol.mintyconnect.product.wachtagent"
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Failed to add account"
}

Update an existing module

PUT https://dev.bol.mintycloud.nl/api/v1/modules

This endpoint updates modules

Request Body

Name	Type	Description
identifier*	String
name	String
description	String
enabled	Boolean
isBase	Boolean
users	Array

200: OK Created successfully bol account

{
    "bolUserId": 1
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Something went wrong. Is the identifier already imported?"
}

Delete an existing module

DELETE https://dev.bol.mintycloud.nl/api/v1/modules

This endpoint deletes modules

Query Parameters

Name	Type	Description
identifier*	String

200: OK Deleted successfully moduole

{
    "message": "Module removed."
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Something went wrong. Is the identifier already imported?"
}

400: Bad Request Invalid identifier.

{
    "error": "Invalid identifier."
}