https://github.com/onify/blueprint-cloudblue-commerce-api-authenticate
Onify Blueprint: Authenticate against CloudBlue Commerce API
https://github.com/onify/blueprint-cloudblue-commerce-api-authenticate
bpmn cloudblue integration onify onify-blueprint onify-blueprints rest-api
Last synced: 6 months ago
JSON representation
Onify Blueprint: Authenticate against CloudBlue Commerce API
- Host: GitHub
- URL: https://github.com/onify/blueprint-cloudblue-commerce-api-authenticate
- Owner: onify
- License: mit
- Created: 2023-02-15T10:43:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T14:48:52.000Z (over 3 years ago)
- Last Synced: 2025-02-16T17:57:03.950Z (over 1 year ago)
- Topics: bpmn, cloudblue, integration, onify, onify-blueprint, onify-blueprints, rest-api
- Language: JavaScript
- Homepage: https://onify.co
- Size: 382 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.repostatus.org/#wip)
# Onify Blueprint: Authenticate against CloudBlue Commerce API
## About
### About CloudBlue
[CloudBlue](https://www.cloudblue.com) is a SaaS company that is helping businesses transform themselves, whatever their position in the supply chain. They provide a managed marketplace platform that takes the complexity out of distributing subscription- based solutions in the everything-as-a-service world.
[CloudBlue Commerce](https://www.cloudblue.com/commerce/) is multi-tier commerce platform that allows companies to build marketplaces.
> Also checkout https://github.com/cloudblue.
### About this Blueprint
In this Blueprint we show how to generate a access token to the CloudBlue Commerce REST API. From there you can then manage things like customers, orders and subscriptions.
## Requirements
* [Onify Hub](https://github.com/onify/install)
* [Camunda Modeler](https://camunda.com/download/modeler/)
* [CloudBlue Commerce](https://www.cloudblue.com/commerce/)
## Included
* 1 x Flow (BPMN)
## Setup
### CloudBlue Commerce
[Follow these instructions to get a API Subscription Key](https://kb.cloud.im/support/solutions/articles/66000489946-how-to-get-cloud-marketplace-api-subscription-key).
> For more information about the CloudBlue Commerce API, please see https://apidocs.cloud.im/1.8/howto/ready.
### Onify
Add the following settings in Onify.
|Key|Name|Value|Type|Tag|Role|Description|
|---|----|-----|----|---|----|-----------|
|cloudblue_baseurl|CloudBlue Base URL|``|string|cloudblue, frontend|admin|The Base URL for the API, eg. `https://api.cloud.im/marketplace/eu`|
|cloudblue_marketplace|CloudBlue Marketplace|``|string|cloudblue, frontend|admin|The short name for the commercial marketplace, eg. `se`|
|cloudblue_subscriptionkey|CloudBlue Subscription Key|``|password|cloudblue, frontend|admin|Subscription to API services that contains certain limits on the API usage, for example, it defines the upper limit on the number of requests your system can send per a period of time. |
|cloudblue_username|CloudBlue Username|``|string|cloudblue, frontend|admin|Username is the login name to authenticate your system.|
|cloudblue_password|CloudBlue Password|``|password|cloudblue, frontend|admin|Password for the user|
> Note: Creating settings via admin interface add a trailing `_` in key. This is required for flow to work.
## Deploy
1. Open the BPMN diagram in Camunda Modeler.
2. Deploy the BPMN diagram (click `Deploy current diagram` and follow the steps).
## Run
This workflow should be run as a _adhoc workflow_ and can be part of another process.
Here is an example how to get a secret using a simple `curl` command.
```bash
curl -X 'POST' \
'http://localhost:8181/api/v2/my/workflows/run/cloudblue-commerce-api-authenticate' \
-H 'authorization: {auth-token}'
```
And here is the result:
```json
{
"output": {
"token": "eyJhbGciOiJIUzM4NCJ9..."
},
"status": {
"statuskey": "complete"
}
}
```
> You can also copy the flow elements into another flow if you want to get the same result but in another workflow without running it as a adhoc workflow.
## Support
* Community/forum: https://support.onify.co/discuss
* Documentation: https://support.onify.co/docs
* Support and SLA: https://support.onify.co/docs/get-support
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.