Conexa logo
Documentation Powered by ReDoc

Conexa API - Conexa Plus (1.0.0)

Download OpenAPI specification:Download

E-mail: suporte.ti@conexasaude.com.br URL: https://www.conexasaude.com.br/ License: Apache 2.0 Terms of Service

Serviços integrados de trabalhos externos de empresas parceiras, ligados a disponibilidade do Conexa Plus dentro da plataforma de telemedicina da Conexa Saúde.

Para saber mais sobre a Conexa: https://www.conexasaude.com.br/.

Introdução

Conexa API - Conexa Plus Este guia tem por objetivo ajudar você desenvolvedor a preparar a plataforma para receber endpoints de dentro da aplicação da propria Conexa, ligados a serviços extrernos de empresas parceiras.

Autenticação

Será realizada sempre pelo USUARIO-PACIENTE logado dentro da aplicação.

Financeiro

Representa endpoint do parceiro financeiro dentro da plataforma Conexa

Endpoint de redirecionamento

Esse endpoint serve para redirecionar o Paciente para dentro da aplicação de nossa empresa parceira de serviço de bem estar financeiro.

header Parameters
token
required
string

token API de paciente

Request Body schema: application/json

Objeto com informações a respeito do paciente e de empresa ligada a ele.

fullName
required
string

Nome completo do usuario

employerIdentity
required
string

Informações à respeito do CNPJ da empresa vinculada ao usuario

socialSecurityNumber
required
string

Informações à respeito do CPF do usuario

Responses

Request samples

Content type
application/json
{
  • "fullName": "Lyke Skywalker",
  • "employerIdentity": "28567713000150",
  • "socialSecurityNumber": "05984071037"
}

Response samples

Content type
application/json
{}

Guia Para a Mente

Representa endpoint do parceiro de guia para a mente dentro da plataforma Conexa

Endpoint para salvar registro de videos

Esse endpoint serve para salvar ids de videos atrelados ao paciente, registrados na aplicação do serviço parceiro dentro da nossa aplicação e salvar no nosso banco.

path Parameters
videoId
required
integer

ID do video

header Parameters
token
required
string

token API de paciente

Responses

Request samples 

curl "https://api.conexasaude.com.br/cnx-plus/guide-to-mind/videos-viewed/only/1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": null,
  • "object": true,
  • "timestamp": 1591458128186
}

Endpoint para mostrar registro de videos

Esse endpoint serve para mostrar ids de videos atrelados ao paciente, registrados na aplicação do serviço parceiro dentro da nossa aplicação e salvar no nosso banco.

header Parameters
token
required
string

token API de paciente

Responses

Request samples 

curl "https://api.conexasaude.com.br/cnx-plus/guide-to-mind/videos-viewed/only/1" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{
  • "status": "200",
  • "msg": null,
  • "object": [
    ],
  • "timestamp": 1591458128186
}

Vigilantes do Sono

Representa endpoint do parceiro vigilantes do sono dentro da plataforma Conexa

Endpoint para redirecionamento de serviço

Esse endpoint serve para redirecionar o Paciente para dentro da aplicação de nossa empresa parceira de serviço de bem estar na vigilancia do sono.

header Parameters
token
required
string

token API de paciente

Responses

Request samples 

curl "https://api.conexasaude.com.br/cnx-plus/sleep-watchers/free-code" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{}

Meditação

Representa endpoint do parceiro de meditação dentro da plataforma Conexa

Endpoint para redirecionamento de serviço.

Esse endpoint serve para redirecionar o Paciente para dentro da aplicação de nossa empresa parceira de serviço de bem estar de meditação.

header Parameters
token
required
string

token API de paciente

Responses

Request samples 

curl "https://api.conexasaude.com.br/cnx-plus/meditation/link-logged" \
-H "token: SEU_API_TOKEN"

Response samples

Content type
application/json
{}