A Yube disponibiliza para seus clientes e parceiros uma API pública para leitura e gestão dos dados armazenados da Yube.

Funcionamento da API

A API da Yube é desenvolvida utilizando o padrão GraphQL.

O GraphQL é um padrão de API que auxilia nas solicitações de leitura e escrita de dados, do qual utilizamos dois conceitos básicos:

- Query: Descrição das informações que o cliente deseja receber.

- Mutation: Descrição das informações que o cliente deseja enviar e receber como resposta.

Informações de Acesso

A Yube disponibiliza para seus clientes 2 ambientes: o ambiente de produção e de teste.

Ambiente de Produção

• https://api.yube.com.br/graphql: Entrypoint da API.
• https://api.yube.com.br: GraphQL Explorer, ferramenta para teste das requisições e com documentação estrutural GraphQL.
• https://app.yube.com.br: Aplicação Web usada pelo RH, DP e BPO
  https://m.yube.com.br: Aplicação Móvel usada pelo colaborador para envio dos documentos

O ambiente de produção é o ambiente final de uso do RH, BPO e colaborador, sendo assim sempre tenha atenção quando for fazer alterações. A leitura dos dados não corre risco de gerar problemas.

Ambiente para Testes de Integração

O playground para exercícios e testes de integração é estruturado conforme abaixo:

Ambiente 1: Testes de Requisições e Schemas
Ambiente do tipo playground destinado à realização de testes de requisições e consulta aos schemas disponíveis.
Endpoint: https://api.yube.io

Ambiente 2: Testes de Autenticação, Conexão, Webhook e Status
Ambiente do tipo playground voltado à validação de autenticação, conexão, webhook e mudanças de status.
https://api.yube.io/graphql – Entrypoint da API GraphQL.
https://app.yube.io – Ambiente compartilhado que representa uma aplicação web do cliente, com estrutura simplificada dos recursos da plataforma.
https://m.yube.io – Representa a aplicação web do colaborador