Skip to main content

Introduction

Welcome to the Crm Patient Care integration documentation.
Here you will find the information required to consume and use our services through GraphQL.

Environments and Endpoints​

The endpoints available for GraphQL integration are listed below.
Use the sandbox environment for testing and validation before integrating with production.

EnvironmentURLPurpose
Sandboxhttps://beneficiaries-uat.funcionalmais.com/graphqlTesting, validation, and development
Productionhttps://beneficiaries.funcionalmais.com/graphqlOfficial operation and real data
  • Sandbox: Use this environment to validate integrations, run tests, and make sure your system works correctly before going to production.
  • Production: Use this environment only after your integration has been approved and is ready to operate with real data.

GraphQL Integration​

We provide integration through the GraphQL protocol, which enables flexible and efficient data queries.

Authentication​

Learn how to authenticate below:

Creating tokens

Slugs​

Some API endpoints include URL parts used to identify the client, program, and/or follow-up, called slugs. Some possible slugs are:

  • clientSlug: identifies the client
  • programSlug: identifies the program
  • followupSlug: identifies the follow-up
info

These identifiers are used only in URLs and must be provided by our team together with the authentication credentials.

Security​

The production API environment is behind a firewall to prevent unwanted external access. The IP addresses of the servers that will make requests must be sent to our team so access can be allowed.

info

The sandbox environment does not have this restriction, so it can be accessed by developers.