* axiom.ai certified connector

* Adjusted Swagger definition and Readme to conform to Microsoft Guidelines

* Adjusted Swagger definition and Readme to conform to Microsoft Guidelines

Co-authored-by: yaseer <yaseer@axiom.ai>
This commit is contained in:
yaseersheriff 2022-11-28 21:24:35 +00:00 коммит произвёл GitHub
Родитель 639a1096fb
Коммит 3144e1bb01
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 209 добавлений и 0 удалений

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

@ -0,0 +1,20 @@
# Axiom Browser Automation Connector
The Axiom Browser Automation connector lets you connect power automate with axiom.ai to trigger axiom bots.
## Pre-requisites
You will need the following to proceed:</br>
• Active Microsoft Power Automate, Power Apps, Logic Apps account</br>
• An axiom.ai account, with pro subscription, or higher</br>
• You need an API key to access the connector. This can be generated following these instructions: https://axiom.ai/docs/webhook-api-documentation.html#generating-your-api-token
### Supported Operations
• Trigger an axiom bot : Trigger an axiom bot, and pass data to it from power automate.
### Documentation
For more guidelines and best-practices on integrating axiom with other services, please see:
https://axiom.ai/docs/webhook-api-documentation.html

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

@ -0,0 +1,166 @@
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "axiom browser automation",
"description": "axiom browser automation lets you automate web browser actions with no code. This connector lets you trigger axiom bots.",
"contact": {
"name": "Axiom Support",
"url": "https://axiom.ai/customer-support.html",
"email": "support@axiom.ai"
}
},
"host": "lar.axiom.ai",
"basePath": "/",
"schemes": [
"https"
],
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://axiom.ai/"
},
{
"propertyName": "Privacy policy",
"propertyValue": "https://axiom.ai/privacy-policy.html"
},
{
"propertyName": "Categories",
"propertyValue": "Productivity;IT Operations"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/api/v4/trigger": {
"post": {
"security": [
{
"API Key": []
}
],
"summary": "trigger an axiom.ai bot",
"description": "trigger an axiom.ai bot",
"operationId": "TriggerAxiomBot",
"parameters": [
{
"name": "axiom",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
],
"responses": {
"200": {
"description": "Success - your bot is running",
"schema": {
"type": "object",
"properties": {
"OPEN LINK IN BROWSER": {
"type": "string",
"description": "A link you can open in your browser to see your running bot"
}
}
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/ErrorMessage"
}
},
"401": {
"description": "Authentication error",
"schema": {
"$ref": "#/definitions/ErrorMessage"
}
},
"403": {
"description": "Permission denied",
"schema": {
"$ref": "#/definitions/ErrorMessage"
}
},
"404": {
"description": "Axiom not found",
"schema": {
"$ref": "#/definitions/ErrorMessage"
}
}
}
}
}
},
"definitions": {
"ErrorMessage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "status"
},
"message": {
"type": "string",
"description": "message"
}
}
}
},
"parameters": {},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Request payload is empty or not a valid JSON object, please check the formatting and try again"
},
"401": {
"description": "Unable to authenticate, please check your API key and try again"
},
"403": {
"description": "You must have a pro subscription or higher to use this API. Please also check your runtime is not used up."
},
"404": {
"description": "Axiom not found, please check the name and try again."
},
"5XX": {
"description": "Unexpected error."
}
},
"securityDefinitions": {
"API Key": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY"
}
},
"security": [
{
"API Key": []
}
],
"tags": []
}

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

@ -0,0 +1,23 @@
{
"properties": {
"connectionParameters": {
"api_key": {
"type": "securestring",
"uiDefinition": {
"displayName": "key",
"description": "The key for this api",
"tooltip": "Provide your key",
"constraints": {
"tabIndex": 2,
"clearText": false,
"required": "true"
}
}
}
},
"iconBrandColor": "#2D3A48",
"capabilities": [],
"publisher": "axiom.ai",
"stackOwner": "axiom.ai"
}
}