Pluga Basic Info API

openapi: 3.2.0
info:
  title: Pluga Developers Basic Info 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: BasicInfo
paths:
  /manifest.json:
    get:
      tags:
      - BasicInfo
      summary: Obter informações sobre a configuração do aplicativo
      responses:
        '200':
          $ref: '#/components/responses/successAppConfigResponse'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getManifestJson
      x-operation-id-source: derived
  /ping:
    get:
      tags:
      - BasicInfo
      summary: Validar token de acesso
      security:
      - BearerAuth: []
      description: Este endpoint é usado para validar o token de acesso e retornar informações do usuário.
      responses:
        '200':
          description: Token validado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pingResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: getPing
      x-operation-id-source: derived
components:
  responses:
    NotFound:
      description: Not Found
    successAppConfigResponse:
      description: "Recupera informações sobre a configuração do aplicativo. A resposta inclui detalhes como:\n  - `version`: A versão das informações de configuração do aplicativo.\n  - `name`: O nome do App.\n  - `description`: Uma breve descrição localizada do aplicativo.\n  - `color`: A cor primária associada ao aplicativo (por exemplo, \"#000000\").\n  - `website`: A URL do site do aplicativo.\n  - `signup_url`: A URL para cadastro de usuários.\n  - `base_url`: A URL base para a API do aplicativo.\n  - `authentication`: Detalhes sobre o método de autenticação, incluindo:\n    - `access_token_label`: O rótulo localizado para o token de acesso.\n    - `access_token_tutorial`: Uma lista de etapas ou instruções para obter o token de acesso. Deve ser um array de objetos com a seguinte estrutura:\n      - `content`: Um objeto contendo o conteúdo localizado do tutorial.\n      - `img_url`: Um objeto contendo a URL da imagem associada ao tutorial.\n    - `webhook_tutorial`: Um objeto contendo o tutorial para configurar o webhook, caso aplicável (em casos que contenha algum Trigger do tipo webhook). Contém a seguinte estrutura:\n      - `webhook_page_url`: Um objeto contendo um campo de \"link\" e um \"label\" da seguinte forma:\n        - `link`: URL da página onde o webhook deve ser configurado na sua ferramenta.\n        - `label`: Um objeto contendo o nome localizado do campo que deve ser preenchido com o nome da página do link.\n      - `tutorial`: Um array de objetos com a seguinte estrutura:\n        - `content`: Um objeto contendo o conteúdo localizado do tutorial.\n        - `img_url`: Um objeto contendo a URL da imagem associada ao tutorial.\n"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/appConfigResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthorized
  schemas:
    appConfigResponse:
      type: object
      properties:
        version:
          type: string
          example: 1.0.0
        name:
          type: string
          example: Pluga
        color:
          type: string
          example: '#000000'
        description:
          type: object
          properties:
            pt_BR:
              type: string
              example: Uma breve descrição
            en:
              type: string
              example: A brief description
        website:
          type: string
          example: https://example.com
        signup_url:
          type: string
          example: https://example.com/signup
        base_url:
          type: string
          example: https://api.example.com/v1
        authentication:
          type: object
          properties:
            access_token_label:
              type: object
              properties:
                pt_BR:
                  type: string
                  example: Token de acesso da API
                en:
                  type: string
                  example: API Access token
            access_token_tutorial:
              type: array
              items:
                $ref: '#/components/schemas/tutorialExample'
            webhook_tutorial:
              type: object
              properties:
                webhook_page_url:
                  type: object
                  properties:
                    link:
                      type: string
                      example: https://example.com/webhook
                    label:
                      type: object
                      properties:
                        pt_BR:
                          type: string
                          example: Configurar Webhook
                        en:
                          type: string
                          example: Configure Webhook
                tutorial:
                  type: array
                  items:
                    $ref: '#/components/schemas/tutorialExample'
    tutorialExample:
      type: object
      properties:
        content:
          type: object
          properties:
            pt_BR:
              type: string
            en:
              type: string
        img_url:
          type: object
          properties:
            pt_BR:
              type: string
            en:
              type: string
    pingResponse:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        scopes:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer