Fluid GraphQL API

10min
Introdução
O conector Fluid GraphQL API permite a interação com as APIs GraphQL da Fluid de maneira eficiente, permitindo consultas e mutações de dados para as APIs disponibilizadas para nosso console web.
Funcionalidades principais
Consultas e Mutations: Permite realizar queries e mutations nas APIs GraphQL fornecidas pela Fluid.
Configuração de Template: Facilita a criação e manutenção de templates para montagem da query para consultas complexas.
Autenticação
O Conector Fluid GraphQL API utiliza autenticação baseada em chave API para garantir a segurança das suas requisições. Crie a API Keys﻿ no seu workspace.
Configuração do conector
Parâmetros de configuração
Operação: Define a operação a ser realizada (Query).
Template: Área onde você pode definir e editar o template da consulta ou mutação GraphQL.
Exemplo de Template de Query
Nesse exemplo é possível recuperar os dados de uma conexão criada com o nome especificado:
GraphQL
query ($filter: ConnectionFilter) {
  data: allConnections(filter: $filter) {
    id
    name
    status
    total: count
  }
}

{
  "variables": {
    "filter": {
      "name": "vtex-loja-principal"
    }
  }
}

query ($filter: ConnectionFilter) {
  data: allConnections(filter: $filter) {
    id
    name
    status
    total: count
  }
}

{
  "variables": {
    "filter": {
      "name": "vtex-loja-principal"
    }
  }
}
﻿
Guia de utilização
Passo a passo para configuração
Selecionar Operação: Escolha Query para a requisição às nossas APIs GraphQL da Fluid.
Definir Template: Utilize a aba Template para inserir a consulta GraphQL desejada. Você pode utilizar variáveis e parâmetros para tornar a consulta dinâmica.
Exemplo de configuração: Busca de requisições entre datas
Neste exemplo, efetuaremos uma busca de requisiçoes entre o dia 10/09/2024 e 11/09/2024.
Primeiro, adiciono o conector Fluid GraphQL API ao canvas. Para isso basta arrastá-lo:
﻿
Em seguida, navego até  Template﻿ , agora adiciono a query que quero executar:
GraphQL
{
    "query": "\n  query (\n    $page: Int\n    $perPage: Int\n    $sortField: String\n    $sortOrder: String\n    $filter: RequestFilter\n  ) {\n    data: allRequests(\n      page: $page\n      perPage: $perPage\n      sortField: $sortField\n      sortOrder: $sortOrder\n      filter: $filter\n    ) {\n      \n  hash\n  timestamp\n  duration\n  status\n  engine {\n    step\n    flow_name\n  tags\n}\n\n    }\n\n    total: _allRequestsMeta(page: $page, perPage: $perPage, filter: $filter) {\n      count\n      __typename\n    }\n  }\n",
    "variables": {
        "page": 0,
        "perPage": 10,
        "sortField": "timestamp",
        "sortOrder": "DESC",
        "filter": {
            "from":"2024-09-10T00:00:00-03:00",
            "to":"2024-09-11T23:59:59-03:00"
            }
    }
}
{
    "query": "\n  query (\n    $page: Int\n    $perPage: Int\n    $sortField: String\n    $sortOrder: String\n    $filter: RequestFilter\n  ) {\n    data: allRequests(\n      page: $page\n      perPage: $perPage\n      sortField: $sortField\n      sortOrder: $sortOrder\n      filter: $filter\n    ) {\n      \n  hash\n  timestamp\n  duration\n  status\n  engine {\n    step\n    flow_name\n  tags\n}\n\n    }\n\n    total: _allRequestsMeta(page: $page, perPage: $perPage, filter: $filter) {\n      count\n      __typename\n    }\n  }\n",
    "variables": {
        "page": 0,
        "perPage": 10,
        "sortField": "timestamp",
        "sortOrder": "DESC",
        "filter": {
            "from":"2024-09-10T00:00:00-03:00",
            "to":"2024-09-11T23:59:59-03:00"
            }
    }
}
﻿
Adiciono o tipo da operação (neste caso query).
﻿
Agora, propriedades, também preciso adicionar  Conexões﻿ , com a configuração de tenant e API Key﻿ para a autorização de busca desses dados:
﻿
Pronto! Agora sua primeira operação com o conector Fluid GraphQL API﻿ está pronta. Continue usando e testando novas formas de integrar e lembre-se sempre de consultar outros tópicos da nossa documentação. 
Melhores práticas
Utilização de Variáveis: Utilize as respostas de outros passos para criar queries dinâmicas e poderosas.
Retorne o que precisar: Para uma melhor performance, aproveite o poder do GraphQL e defina exatamente os campos que precisará na resposta.
Conclusão
O conector Fluid GraphQL API simplifica a interação com os serviços GraphQL da Fluid, permitindo a realização de consultas e mutações de forma eficiente e configurável. Com uma interface intuitiva e a capacidade de definir templates personalizados, este conector é uma ferramenta poderosa para as APIs disponibilizadas pela Fluid para integrações modernas.
Updated 12 Sep 2024
Did this page help you?
Fluid Flowkit
Fluid Error