Tem Empresas

Desenvolvedores

API v1.0.0

Voltar à home

Integre seu produto à Tem Empresas

Nossa API permite embarcar o logon e o onboarding do beneficiário dentro do seu aplicativo e gerenciar dependentes com validação automática das regras de elegibilidade do contrato. A especificação abaixo é a fonte oficial: tudo o que já está disponível e também o que está no roteiro, com o contrato já publicado.

Produção
https://temempresas.com
Homologação
https://tem-empresas.lovable.app
Comece a integrar agora
Cadastre sua aplicação e receba na hora uma credencial de homologação (tem_test_…) para testar sem tocar em dados reais. Quando estiver pronto, peça a credencial de produção (tem_live_…) — nosso time de tecnologia libera depois de conferir suas permissões.

Endpoints

MétodoCaminhoSituação
GET/api/public/arquivo/{token}Disponível
POST/api/public/cron/faturamento-automaticoDisponível
POST/api/public/cron/faturas-vencimentoDisponível
POST/api/public/cron/renovacoesDisponível
POST/api/public/cron/tem-integra-enviosDisponível
POST/api/public/cron/tem-saude-enviosDisponível
POST/api/public/cron/vigencia-contratosDisponível
POST/api/public/onboarding/sessaoDisponível
GET/api/public/onboarding/sessao/{id}Disponível
GET/api/public/parceiro/beneficiario/statusPlanejado
POST/api/public/parceiro/embed/launchPlanejado
POST/api/public/parceiro/oauth/tokenPlanejado
POST/api/public/parceiro/vidas/dependentePlanejado
POST/api/public/parceiro/vidas/dependente/exclusaoPlanejado

Como autenticar

Cada parceiro recebe um client_id e um client_secret por ambiente. Troque-os por um token Bearer de 10 minutos e envie o token em todas as chamadas. O token carrega escopos: cada endpoint exige o escopo indicado na sua descrição. O segredo nunca deve trafegar no aplicativo do usuário final — mantenha a troca no seu servidor.

curl -X POST https://temempresas.com/api/public/parceiro/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=$CLIENT_ID" \
  -d "client_secret=$CLIENT_SECRET" \
  -d "scope=embed:launch vida:dependente:incluir"

Com o token em mãos:

curl -X POST https://temempresas.com/api/public/parceiro/vidas/dependente \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf_titular": "84752390990",
    "cpf": "39218477014",
    "nome": "Ana Beatriz Souza",
    "data_nascimento": "2010-04-22",
    "parentesco": "filho"
  }'

Catálogo de erros

Toda falha volta como { "sucesso": false, "codigo", "mensagem" }. Trate pelo código, que é estável; a mensagem é amigável e pode ser exibida ao usuário final.

HTTPCódigoMensagem ao usuário
401AUTH_CREDENCIAL_INVALIDACredenciais do parceiro inválidas ou aplicação desativada.
401AUTH_TOKEN_EXPIRADOSua sessão de integração expirou. Solicite um novo token.
403AUTH_ESCOPO_INSUFICIENTEEsta aplicação não tem permissão para executar esta operação.
401LAUNCH_TOKEN_INVALIDOLink de acesso inválido ou já utilizado. Abra novamente pelo aplicativo.
404TITULAR_NAO_ENCONTRADONão encontramos um titular ativo com este CPF.
422TITULAR_INATIVOO titular está inativo e não pode incluir dependentes.
422CONTRATO_SEM_VIGENCIAO contrato da empresa não está em vigência.
409DEP_CPF_JA_ATIVOEste CPF já está ativo neste contrato.
422DEP_BLOQUEIO_REINCLUSAOEste dependente saiu recentemente e só pode voltar após o prazo de carência.
422DEP_PERMANENCIA_MINIMAO dependente precisa cumprir a permanência mínima antes desta alteração.
422DEP_IDADE_LIMITEDependente acima da idade limite. Filhos maiores só entram com comprovação de universitário.
422DEP_PARENTESCO_NAO_ELEGIVELEste grau de parentesco não é elegível no contrato da empresa.
422PRODUTO_SEM_DEPENDENTEO produto contratado não prevê inclusão de dependentes.
400DADOS_INVALIDOSAlguns campos estão incompletos ou inválidos.
429LIMITE_EXCEDIDOMuitas requisições em sequência. Tente novamente em instantes.
500ERRO_INTERNONão conseguimos concluir a operação agora. Tente novamente.

Documentação interativa

Carregando…

Roadmap

Rede credenciada
Planejado

Consulta de prestadores por especialidade e proximidade.

Carteirinha digital
Planejado

Dados da carteirinha do beneficiário para exibição no app do parceiro.

Agendamento
Planejado

Solicitação de teleconsulta e de atendimento presencial.

Webhook de eventos de vida
Planejado

Notificação de inclusão, alteração e exclusão de vidas para o parceiro.

Serviços que consumimos

Para transparência da arquitetura: estas são integrações em que a Tem Empresas é a cliente. Não são endpoints nossos.

FornecedorSituação
TEM IntegraAtiva
Itaú — cobrançaAtiva
Microsoft GraphAtiva
TwilioAtiva
MapboxAtiva
IBGE — localidadesAtiva

Fale com o time de integração

Para receber credenciais de homologação, cadastrar os deep links do seu aplicativo ou propor um novo endpoint, escreva para integracoes@temempresas.com.