Pular para o conteúdo principal

GraphQL API para Perfex CRM

Uma API GraphQL flexível que permite conexões de terceiros sem complicações dentro do Perfex CRM. Interaja com tabelas nativas e módulos personalizados.

Visão Geral​

O módulo GraphQL API expõe um endpoint de API poderoso e flexível para sua instalação do Perfex CRM. Diferente das APIs REST tradicionais onde você precisa de múltiplos endpoints para diferentes recursos, o GraphQL permite que você consulte exatamente os dados que precisa em uma única requisição. O módulo gera automaticamente um schema baseado no banco de dados do seu Perfex CRM — incluindo tabelas nativas e quaisquer módulos personalizados que você tenha instalado.

Capacidades Principais​

CapacidadeDescrição
QueriesLeia dados de qualquer tabela do CRM — clientes, faturas, leads, tarefas e mais
MutationsCrie, atualize e exclua registros através da API
Schema Auto-GeradoO schema é automaticamente construído a partir da estrutura do banco de dados do seu Perfex CRM
Módulos PersonalizadosInteraja com dados de módulos de terceiros instalados no seu CRM
Endpoint ÚnicoTodas as operações passam por um endpoint — sem necessidade de gerenciar múltiplas rotas de API
informação

Seu endpoint GraphQL estará disponível em https://seudominio.com/graphql imediatamente após a ativação. O schema é gerado automaticamente a partir da sua instalação do Perfex CRM.

Requisitos​

Antes de instalar o módulo, certifique-se de que você tem:

  • Uma instalação ativa do Perfex CRM
  • PHP 7.4 ou superior no seu servidor
  • As extensões PHP cURL e JSON habilitadas
  • Uma License Key válida para o módulo

Instalação e Ativação​

Siga estes passos para instalar e ativar o módulo GraphQL API:

  1. Extraia seu download e localize o upload.zip.
  2. No Perfex CRM, vá para Setup → Modules.
  3. Faça o upload do upload.zip e pressione Install.
  4. Clique em Activate e insira sua License Key.
dica

Após a ativação, você pode testar imediatamente seu endpoint visitando https://seudominio.com/graphql no seu navegador ou enviando uma requisição usando uma ferramenta como Postman ou GraphQL Playground.

Após a Instalação​

Uma vez que o módulo esteja ativado, o endpoint GraphQL está ativo e pronto para aceitar requisições:

  1. Localize seu endpoint — A API está disponível em https://seudominio.com/graphql.
  2. Autentique suas requisições — Consulte o guia de Autenticação para detalhes sobre como obter e usar tokens de API.
  3. Explore o schema — Use a introspecção do GraphQL para descobrir todas as queries e mutations disponíveis.
  4. Comece a consultar — Consulte o guia de Operações de Dados para exemplos de queries e mutations.
aviso

O endpoint GraphQL é publicamente acessível por URL, mas todas as requisições requerem autenticação adequada. Certifique-se de configurar seus tokens de API e mantê-los seguros.

Próximos Passos​

Explore os seguintes guias para aproveitar ao máximo o módulo GraphQL API:

Suporte​

Se você encontrar qualquer problema durante a instalação ou precisar de ajuda com a API, visite o Portal de Suporte da Themesic para abrir um ticket de suporte.