Centrical - Certification + Remove requirements for custom script (#1796)

* Submit Centrical Connector for Certification

* Removed requirements for custom script

* Fixing comments from the Microsoft Certification Team.

* Fixing api swagger description

Co-authored-by: doron <Doron.Neumann@gameffective.com>
This commit is contained in:
Doron Neumann 2022-07-26 16:52:20 +03:00 коммит произвёл GitHub
Родитель 30db6fb699
Коммит e39897d8ef
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 319 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,42 @@
# Centrical Connector
[Centrical](https://centrical.com) is the next-gen employee engagement and performance platform
Centrical dynamically brings together real-time performance management, personalized microlearning, augmented coaching, and advanced gamification to personally guide employees and their managers to success.
## Publisher: Centrical
## Prerequisites
- A Microsoft Power Apps or Power Automate plan with custom connector features
- A Centrical account
- A Centrical API Key (Available via the Centrical Administration Console)
## Supported Operations
- `Post Learning Event` - Post a learning event to the Centrical Platform
- `Post Performance Event` - Post a performance event to the Centrical Platform
## Obtaining Credentials
Centrical API Key credentials are available only to Centrical system administrators.
Log in to the Centrical administration console -> Security and generate your API key.
The information on the location of Centrical instance data-center is shown in the security section.
## Known Issues and Limitations
None.
## Frequently Asked Questions
### How to obtain a Centrical account?
Centrical is an enterprise platform and does not support user self-service sign up.
To obtain a Centrical account you must contact Centrical using this [link.](https://centrical.com/free-demo/)
## Deployment instructions
Please use [these instructions](https://docs.microsoft.com/en-us/connectors/custom-connectors/paconn-cli) to deploy this connector as custom connector in Microsoft Power Automate and Power Apps.
## More Information
The Centrical connector uses the Centrical REST API to post learning and performance events to the Centrical platform.
These learning and performance events drive the Centrical platform, allowing employees and managers to:
- Keep objectives on-point
- Sustain goal focus
- Coach to win
- Create a learning culture
- Drive proficiency
- Enhance collaboration
- And much more

Просмотреть файл

@ -0,0 +1,200 @@
{
"swagger": "2.0",
"info": {
"title": "Centrical",
"description": "Send learning and performance events to Centrical platform.",
"version": "1.0",
"contact": {
"name": "Centrical support",
"url": "https://centrical.com/support",
"email": "support@centrical.com"
}
},
"host": "api.centrical.me",
"basePath": "/v1",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/import/push/lms_{learning_type}": {
"post": {
"summary": "Post a learning event",
"description": "Use this option to send a learning event to the Centrical platform",
"operationId": "PostLearning",
"x-ms-visibility": "important",
"parameters": [
{
"name": "learning_type",
"in": "path",
"required": true,
"type": "string",
"default": "CourseCompleted",
"description": "Learning Event Type",
"x-ms-summary": "Learning Event Type",
"x-ms-url-encoding": "single"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"event_time": {
"type": "string",
"format": "date-time",
"description": "Date Time",
"x-ms-summary": "Date Time"
},
"user_id": {
"type": "string",
"description": "User Id",
"x-ms-summary": "User Id"
},
"course_name": {
"type": "string",
"description": "Course Name",
"x-ms-summary": "Course Name"
},
"score": {
"type": "integer",
"format": "int32",
"description": "Score",
"x-ms-summary": "Score"
},
"course_category": {
"type": "string",
"description": "Course Category",
"x-ms-summary": "Content Category",
"x-ms-visibility": "advanced"
}
},
"required": [
"user_id",
"course_name",
"event_time",
"score"
]
}
}
],
"responses": {
"200": {
"description": "Post was successful"
},
"401": {
"description": "Post was not applied because credentials could not be authenticated"
}
}
}
},
"/import/push/kpi_{performance_type}": {
"post": {
"summary": "Post a Performance Event",
"description": "Use this option to send a performance (KPI) event to the Centrical platform. This event is scored and can trigger additional actions within Centrical",
"operationId": "PostPerformance",
"x-ms-visibility": "important",
"parameters": [
{
"name": "performance_type",
"in": "path",
"required": true,
"default": "Kpi",
"type": "string",
"description": "Event Type",
"x-ms-summary": "Event Type",
"x-ms-url-encoding": "single"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"event_time": {
"type": "string",
"format": "date-time",
"description": "Date Time",
"x-ms-summary": "Date Time"
},
"user_id": {
"type": "string",
"description": "User Id",
"x-ms-summary": "User Id"
},
"kpi_name": {
"type": "string",
"description": "Kpi Name",
"x-ms-summary": "Kpi Name"
},
"kpi_value": {
"type": "integer",
"format": "int32",
"description": "Kpi Value",
"x-ms-summary": "Kpi Value"
},
"additional_data": {
"type": "string",
"description": "Additional Data",
"x-ms-summary": "Additional Data",
"x-ms-visibility": "advanced"
}
},
"required": [
"user_id",
"kpi_name",
"kpi_value",
"event_time"
]
}
}
],
"responses": {
"200": {
"description": "Post was successful"
},
"401": {
"description": "Post was not applied because credentials could not be authenticated"
}
}
}
}
},
"definitions": {},
"parameters":{},
"responses": {},
"securityDefinitions": {
"API Key": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
}
},
"security": [
{
"API Key": []
}
],
"tags": [],
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://centrical.com/"
},
{
"propertyName": "Privacy policy",
"propertyValue": "https://centrical.com/privacy/"
},
{
"propertyName": "Categories",
"propertyValue": "Productivity;Sales and CRM"
}
]
}

Просмотреть файл

@ -0,0 +1,77 @@
{
"properties": {
"connectionParameters": {
"api_key": {
"type": "securestring",
"uiDefinition": {
"displayName": "API Key",
"description": "The API Key for this api",
"tooltip": "Provide your API Key",
"constraints": {
"tabIndex": 1,
"clearText": true,
"required": true
}
}
},
"region": {
"type": "string",
"uiDefinition": {
"displayName": "Region",
"tooltip": "Select Data Center to use",
"constraints": {
"required": "true",
"allowedValues": [
{
"text": "US (Default)",
"value": "api.centrical.me"
},
{
"text": "EU",
"value": "apieu.centrical.me"
},
{
"text": "APAC",
"value": "apiap.centrical.me"
}
]
}
}
}
},
"iconBrandColor": "#F5F5F5",
"capabilities": [],
"policyTemplateInstances": [
{
"templateId": "setheader",
"title": "Content-Type",
"parameters": {
"x-ms-apimTemplateParameter.name": "Content-Type",
"x-ms-apimTemplateParameter.value": "application/json",
"x-ms-apimTemplateParameter.existsAction": "override",
"x-ms-apimTemplate-policySection": "Request"
}
},
{
"templateId": "setheader",
"title": "Accept",
"parameters": {
"x-ms-apimTemplateParameter.name": "Accept",
"x-ms-apimTemplateParameter.value": "application/json",
"x-ms-apimTemplateParameter.existsAction": "override",
"x-ms-apimTemplate-policySection": "Request"
}
},
{
"templateId": "dynamichosturl",
"title": "baseUrl",
"parameters": {
"x-ms-apimTemplateParameter.urlTemplate": "https://@connectionParameters('region')/v1"
}
}
],
"publisher": "Centrical",
"stackOwner": "Centrical"
}
}