Connectors

Основные методы для работы с коннекторами

Получение списка доступных коннекторов

GET https://api.mixapp.io/v1/workplaces/:name/connectors

Path Parameters

Name	Type	Description
name	string	Имя workplace

Headers

Name	Type	Description
X-Auth-Token	string	Токен, полученный при авторизации

200

{
    "items": [
        {
            "id": "5c7654850dec1f9f4f2686bc",
            "name": "Timer",
            "description": "Timer allows you to delay the execution of child connectors",
            "image": "",
            "owner": "mixapp",
            "version": "1.0.8",
            "methods": [
                {
                    "title": "Default",
                    "value": "default",
                    "http_methods": []
                }
            ],
            "dataMapping": {
                "input": {
                    "default": {
                        "type": "object",
                        "required": false,
                        "properties": {
                            "date": {
                                "type": "string",
                                "required": true,
                                "presenter": {
                                    "title": "",
                                    "desc": "",
                                    "component": "date",
                                    "visible": {},
                                    "tags": [],
                                    "order": 0,
                                    "multi": false,
                                    "default": null,
                                    "values": []
                                }
                            }
                        }
                    }
                },
                "output": {
                    "default": {
                        "type": "object",
                        "required": false,
                        "properties": {}
                    }
                }
            }
        }
    ]
}

Создание нового коннектора

POST https://api.mixapp.io/v1/workplaces/:name/connectors

Path Parameters

Name	Type	Description
name	string	Имя workplace

Headers

Name	Type	Description
Content-Type	string	application/json
X-Auth-Token	string	Токен, полученный при авторизации

Request Body

Name	Type	Description
	object	Объект, описывающий коннектор, смотрите раздел Схема коннектора

200

{
    "result": "5cc6faa1574e7400012a9f50"
}

Example request

{
    "dataMapping":{
        "input":{
            "default":{
                "type":"object",
                "properties":{}
            }
        },
        "output":{
            "default":{
                "type":"object",
                "properties":{}
            }
        }
    },
    "name":"Connector name",
    "npm":[],
    "information":"<p>More information...</p>",
    "code":"return Promise.resolve();",
    "installHandler":"return Promise.resolve();",
    "methods":[{"value":"default","title":"First Method"}],
    "version":"0.1.0",
    "type":"custom",
    "description":"Connector description"
}

Обновление коннектора

POST https://api.mixapp.io/v1/workplaces/:name/connectors/:id

Path Parameters

Name	Type	Description
id	string	Идентификатор, редактируемого коннектора
name	string	Имя workplace

Headers

Name	Type	Description
Content-Type	string	application/json
X-Auth-Token	string	Токен, полученный при авторизации

Request Body

Name	Type	Description
	object	Объект, описывающий коннектор, смотрите раздел Схема коннектора

200

{
    "result":true
}

Example request

{
    "dataMapping":{
        "input":{
            "default":{
                "type":"object",
                "properties":{}
            }
        },
        "output":{
            "default":{
                "type":"object",
                "properties":{}
            }
        }
    },
    "name":"Connector name",
    "npm":[],
    "information":"<p>More information...</p>",
    "code":"return Promise.resolve();",
    "installHandler":"return Promise.resolve();",
    "methods":[{"value":"default","title":"First Method"}],
    "version":"0.1.0",
    "type":"custom",
    "description":"Connector description"
}

Удаление коннектора

DELETE https://api.mixapp.io/v1/workplaces/:name/connectors/:id

Path Parameters

Name	Type	Description
id	string	Идентификатор, редактируемого коннектора
name	string	Имя workplace

Headers

Name	Type	Description
X-Auth-Token	string	Токен, полученный при авторизации

200

{
    "result":true
}