---
title: Fluid GraphQL API
slug: fluid-graphql-api
docTags: 
createdAt: 2024-06-10T19:34:09.061Z
---

## 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](docId\:U9RzUlsUP_oXxCqF5Mu_8) no seu workspace.

## Configuração do conector

### Parâmetros de configuração

1. **Operação**: Define a operação a ser realizada (*Query*).
2. **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"
    }
  }
}

```

## Guia de utilização

### Passo a passo para configuração

1. **Selecionar Operação**: Escolha *Query* para a requisição às nossas APIs GraphQL da Fluid.
2. **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:

::Image[]{src="https://api.archbee.com/api/optimize/G1NTw6yAi4RDUYbsU8csp/HgbKgT_Rc47NjpBXpjaiR_screenshot-2024-09-11-at-072744.png" size="50" width="1134" height="676" position="center" showCaption="false"}

Em seguida, navego até  [Template](docId\:TReaJH8tvdyh6uKYEAQZP) , 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"
            }
    }
}
```

Adiciono o tipo da operação (neste caso *query*).

::Image[]{src="https://api.archbee.com/api/optimize/G1NTw6yAi4RDUYbsU8csp/XLOIvHhxIs9rqmckFd4gl_screenshot-2024-09-11-at-115156.png" size="50" width="860" height="754" position="center" showCaption="false"}

Agora, propriedades, também preciso adicionar  [Conexões](docId\:fDR1Y5sRGt0DnLVqkUekJ) , com a configuração de tenant e [API Key](docId\:VoJXrXx-nFLvlcQIzN7hk) para a autorização de busca desses dados:

::Image[]{src="https://api.archbee.com/api/optimize/G1NTw6yAi4RDUYbsU8csp/mu3FGyB6AIYIPdT9pyZfc_screenshot-2024-09-11-at-115348.png" size="50" width="846" height="1310" position="center" showCaption="false"}

Pronto! Agora sua primeira operação com o conector [Fluid GraphQL API](docId:3b2RCzbCFIraG1lBkyXg1) 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.