Introdução
Bem-vindo à documentação de integração do WsAcesso GraphQL (Wrapper).
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.
| Ambiente | URL | Finalidade |
|---|---|---|
| Homologação | https://beneficiaries-uat.funcionalmais.com/graphql | Testes, validação e desenvolvimento |
| Produção | https://beneficiaries.funcionalmais.com/graphql | Operaçã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.
📦 Padrões de Retorno
Os resultados das operações seguem o padrão abaixo para garantir consistência e facilitar o tratamento de respostas:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code | Int | Código do retorno |
| status | String | Status do retorno. "00" para sucesso e "01" para erro |
| message | String | Mensagem relativa ao status de retorno |
⚠️ Tratamento de Erros
Além do código e mensagem, erros específicos podem ser retornados em campos adicionais, dependendo da operação realizada.
É importante que o cliente verifique sempre o campo code antes de processar os dados retornados para garantir que a operação foi concluída com sucesso.