Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Pluga Developers Helpers API
version: 1.0.0
description: 'Esta documentação é destinada a desenvolvedores que desejam integrar suas aplicações com a Pluga por meio da criação de uma API, seguindo os endpoints especificados a seguir.
Para que possamos cadastrar os dados do seu aplicativo, bem como suas respectivas Actions e Triggers em nosso banco de dados, é necessário enviar um arquivo JSON para o e-mail integrations@pluga.co, seguindo a estrutura descrita abaixo:
```json
{
"app": {
"id": "example_app",
"base_url": "https://api.example.com"
},
"actions": [
{ "id": "action1_key" },
{ "id": "action2_key" }
],
triggers: [
{ "id": "trigger1_key" },
{ "id": "trigger2_key" }
]
}
```
Os atributos acimas tem a seguinte finalidade:
- `app`: Um objeto representando o aplicativo. Deve conter:
- `id`: Identificador único do aplicativo (por exemplo, "example_app").
- `base_url`: URL base da API do aplicativo (por exemplo, "https://api.example.com").
- `actions`: Array de objetos representando as actions (ações) disponíveis no aplicativo. Cada objeto no array deve conter:
- `id`: Identificador único da ação (por exemplo, "action1_key").
- `triggers`: Array de objetos representando os triggers (gatilhos) disponíveis no aplicativo. Cada objeto no array deve conter:
- `id`: Identificador único do gatilho (por exemplo, "trigger1_key").'
servers:
- url: '{server}'
description: Your API Base URL
variables:
server:
default: https://api.example.com/v1
description: Base URL of your API
tags:
- name: Helpers
paths:
/helpers/{helper_id}:
get:
tags:
- Helpers
summary: Obter opções para um campo de seleção específico
security:
- BearerAuth: []
parameters:
- in: path
name: helper_id
schema:
type: string
required: true
description: ID do Helper para o caminho da API (por exemplo, "stages_list")
responses:
'200':
description: "Retorna uma lista de opções para um campo de seleção específico. Cada objeto no array inclui os seguintes componentes:\n - `label`: Um objeto contendo o nome localizado da opção.\n - `value`: O valor a ser enviado para sua API.\n"
content:
application/json:
schema:
type: array
items:
type: object
properties:
label:
type: object
properties:
pt_BR:
type: string
en:
type: string
value:
type: string
required:
- label
- value
'404':
$ref: '#/components/responses/NotFound'
operationId: getHelpersByHelperId
x-operation-id-source: derived
components:
responses:
NotFound:
description: Not Found
securitySchemes:
BearerAuth:
type: http
scheme: bearer