Pular para o conteúdo principal

Introdução

Bem-vindo à documentação de integração do Crm Patient Care.
Aqui você encontrará as informações necessárias para consumir e utilizar nossos serviços via GraphQL.

🌐 Ambientes e Endpoints​

Abaixo estão os endpoints disponíveis para integração via GraphQL.
Utilize o ambiente de homologação para testes e validações antes de realizar integrações em produção.

AmbienteURLFinalidade
Homologaçãohttps://beneficiaries-uat.funcionalmais.com/graphqlTestes, validação e desenvolvimento
Produçãohttps://beneficiaries.funcionalmais.com/graphqlOperação oficial e dados reais
  • Homologação: Use para validar integrações, realizar testes e garantir que seu sistema está funcionando corretamente antes de ir para produção.
  • Produção: Use apenas quando sua integração estiver homologada e pronta para operar com dados reais.

📡 Integração via GraphQL​

Oferecemos integração através do protocolo GraphQL, que permite consultas flexíveis e eficientes dos dados.

Autenticação​

Saiba mais como efetuar a autenticação abaixo:

Criando tokens

Slugs​

Alguns endpoints da API possuem partes da URL para identificar o cliente, programa e/ou acompanhamento, denominadas slugs. Alguns dos possíveis slugs são:

  • clientSlug: identifica o cliente
  • programSlug: identifica o programa
  • followupSlug: identifica o acompanhamento
info

Esses identificadores são usados apenas em URLs e devem ser informados pelo nosso time junto com as credenciais de autenticação.

Segurança​

O ambiente de produção da API está por trás de um firewall para evitar acesso externo indesejado. Os IPs dos servidores que farão as requisições devem ser enviados ao nosso time para liberação do acesso.

info

O ambiente de homologação não possui esse bloqueio, para que seja acessado por desenvolvedores.