> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Testar uma configuração de provedor

> Utilize este endpoint para testar a conectividade, autenticação e comunicação ponta a ponta com o provedor configurado.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/test
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/provider-configurations/{id}/test:
    post:
      tags:
        - Provider Configurations API
      summary: Testar uma configuração de provedor
      description: >-
        Utilize este endpoint para testar a conectividade, autenticação e
        comunicação ponta a ponta com o provedor configurado.
      operationId: testProviderConfiguration
      parameters:
        - description: Identificador único da configuração do provedor.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigTestResultOutput'
          description: >-
            Indica que a solicitação foi bem-sucedida e a resposta contém os
            dados solicitados.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava malformada ou continha parâmetros
            inválidos.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indica que o recurso solicitado não foi encontrado.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava bem formada, mas contém erros
            semânticos que impedem o processamento.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica um erro interno inesperado. Se persistir, entre em contato
            com o suporte.
components:
  schemas:
    ProviderConfigTestResultOutput:
      example:
        providerConfigId: c3d4e5f6-a7b8-9012-cdef-345678901234
        providerId: clearsale
        overallStatus: passed
        stages:
          - name: dns_resolution
            status: passed
            message: DNS resolved successfully to 104.21.32.15
            durationMs: 45
            details:
              resolvedIP: 104.21.32.15
          - name: authentication
            status: passed
            message: API key accepted (HTTP 200)
            durationMs: 320
          - name: end_to_end
            status: passed
            message: Health endpoint returned OK
            durationMs: 280
        summary: All 3 stages passed. Provider is reachable and authenticated.
        durationMs: 645
        startedAt: '2026-03-17T14:01:00Z'
        completedAt: '2026-03-17T14:01:01Z'
      properties:
        completedAt:
          description: Marca temporal de quando o teste foi finalizado.
          example: '2026-03-17T14:01:02Z'
          format: date-time
          type: string
        durationMs:
          description: Duração total do teste em milissegundos.
          example: 645
          type: integer
        overallStatus:
          description: >-
            Resultado agregado: `passed` se todas as etapas foram bem-sucedidas,
            `failed` se alguma etapa falhou.
          example: passed
          type: string
        providerConfigId:
          description: ID da configuração do provedor que foi testada.
          example: c3d4e5f6-a7b8-9012-cdef-345678901234
          format: uuid
          type: string
        providerId:
          description: ID do provedor do catálogo.
          example: clearsale
          type: string
        stages:
          description: Lista ordenada de etapas de teste com resultados individuais.
          items:
            $ref: '#/components/schemas/StageTestResultOutput'
          type: array
        startedAt:
          description: Marca temporal de quando o teste foi iniciado.
          example: '2026-03-17T14:01:00Z'
          format: date-time
          type: string
        summary:
          description: Resumo legível por humanos dos resultados do teste.
          example: All 3 stages passed. Provider is reachable and authenticated.
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro legível por máquina com o prefixo FLK.
          example: FLK-0001
          type: string
        message:
          description: Explicação do erro legível por humanos.
          example: Invalid input provided
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    StageTestResultOutput:
      properties:
        details:
          additionalProperties:
            type: object
          description: Detalhes adicionais sobre o resultado da etapa.
          example:
            resolvedIP: 104.21.32.15
            ttl: 300
          type: object
        durationMs:
          description: Duração da etapa em milissegundos.
          example: 45
          type: integer
        error:
          description: Mensagem de erro se a etapa falhou.
          type: string
        message:
          description: Descrição legível por humanos do resultado da etapa.
          example: DNS resolved successfully to 104.21.32.15
          type: string
        name:
          description: Nome da etapa de teste.
          example: dns_resolution
          type: string
        status:
          description: 'Resultado da etapa: `passed` ou `failed`.'
          example: passed
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````