Conexa API - Webhook Master (1.0.0)
Download OpenAPI specification:Download
Serviços para integração entre a plataforma de telemedicina da Conexa Saúde e serviços de empresas parceiras da Conexa.
Para saber mais sobre a Conexa: https://www.conexasaude.com.br/.
Conexa API - Webhook Master Este guia tem por objetivo ajudar você desenvolvedor a preparar sua plataforma para receber as notificações dos nossos webhook’s. Portanto, é de suma importância que seja implementado um endpoint para que possamos notificá-los quando isso acontecer e, depois de pronto, nos encaminhar.
Será realizada sempre pelo USUARIO-ADMIN e a implementação da integração final é realizada pelo USUARIO-PACIENTE.
Endpoint responsavel por ver todos os logs referente a empresa e paciente ligados pelo webhook.
Endpoint de checagem de logs
Esse endpoint serve para ver todos os logs referente a empresa e paciente ligados pelo webhook.
header Parameters
| token required | string token API de paciente |
| associateCompanyCNPJ required | string CNPJ da empresa referente ao paciente |
Responses
Request samples
- Bash
curl "https://api.conexasaude.com.br/logs-company/36719501000170/logs-control" \ -H "token: SEU_API_TOKEN"
Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": {
- "id": "91158d91217141248b57bc55e1cdfa9e",
- "patientId": 4181145,
- "associateCompanyId": 23,
- "webhookCompany": {
- "id": 31,
- "method": "POST",
- "token": "eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9",
- "tokenType": null,
- "grantType": null,
- "redirectUri": null,
- "scope": null,
- "createdAt": [
- 2022,
- 10,
- 19,
- 16,
- 3,
- 28
], - "updatedAt": [
- 2022,
- 10,
- 19,
- 16,
- 3,
- 28
], - "action": "UPDATE",
- "active": true,
- "requiresAuthentication": false,
- "associateCompany": {
- "id": 152,
- "name": "Lexly LAW MADE EASY",
- "cnpj": "44585057000175",
- "active": true,
- "createdAt": [
- 2022,
- 10,
- 19,
- 16,
- 3,
- 28
], - "updatedAt": [
- 2022,
- 10,
- 19,
- 16,
- 3,
- 28
]
}, - "authenticationResponse": {
- "accessToken": null,
- "expiresIn": null
}, - "messageError": null,
- "processStatus": "SUCCESS",
- "insertDate": "24/10/2022 17:23:34"
}
}, - "timestamp": 1591458128186
}Representa os endpoints que fazem a ligação entre a empresa na nossa base de dados e também faz a integração final com o paciente.
Endpoint para salvar empresa
Esse endpoint serve para salvar registro de uma empresa parceira.
header Parameters
| token required | string token API de admin |
Request Body schema: application/json
Objeto com informações a respeito do paciente e de empresa ligada a ele.
| name required | string Nome da empresa parceira. |
| cnpj required | string CNPJ da empresa parceira. |
Responses
Request samples
- Payload
- Bash
{- "name": "Lexly LAW MADE EASY",
- "cnpj": "36719501000170"
}Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": {
- "id": 23,
- "name": "Lexly LAW MADE EASY",
- "cnpj": "36719501000170",
- "active": true
}, - "timestamp": 1591458128186
}Endpoint para atualizar empresa
Esse endpoint serve para atualizar o registro de uma empresa parceira no sistema.
path Parameters
| Id required | integer ID da emrpesa parceira |
header Parameters
| token required | string token API de admin |
Request Body schema: application/json
Objeto com informações a respeito do paciente e de empresa ligada a ele.
| name required | string Nome da empresa parceira. |
| cnpj required | string CNPJ da empresa parceira. |
Responses
Request samples
- Payload
- Bash
{- "name": "Lexly LAW MADE EASY",
- "cnpj": "36719501000170"
}Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": {
- "id": 23,
- "name": "Lexly LAW MADE EASY",
- "cnpj": "36719501000170",
- "active": true
}, - "timestamp": 1591458128186
}Endpoint para mudar o status da empresa
Esse endpoint serve para mudar o status do registro de uma empresa parceira no sistema.
path Parameters
| Id required | integer ID da emrpesa parceira |
header Parameters
| token required | string token API de admin |
Responses
Request samples
- Bash
curl "https://api.conexasaude.com.br/associate-company/status/87" \ -H "token: SEU_API_TOKEN"
Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": true,
- "timestamp": 1591458128186
}Endpoint para criar a integração do paciente.
Esse endpoint serve para criar uma integração entre a o paciente e a emrpesa parceira cadastrada.
path Parameters
| Id required | string CNPJ da empresa parceira |
header Parameters
| token required | string token API do paciente |
Responses
Request samples
- Bash
curl "https://api.conexasaude.com.br/associate-company/44585057000175/integrate-patient" \ -H "token: SEU_API_TOKEN"
Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": true,
- "timestamp": 1591458128186
}Representa os endpoints que fazem o cadastro dos webhooks externos dos parceiros dentro da nossa base de dados.
Endpoint para salvar webhook
Esse endpoint serve para salvar registro de webhook de uma empresa parceira.
path Parameters
| associateCompanyId required | integer ID da emrpesa parceira |
header Parameters
| token required | string token API de admin |
Request Body schema: application/json
Objeto com informações a respeito do webhook.
| method required | string Metodo do serviço externo. |
| url required | string URL do serviço externo. |
| action required | string Ação do serviço externo. |
Responses
Request samples
- Payload
- Bash
{- "method": "DELETE",
- "action": "CHANGE_STATUS"
}Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": {
- "id": 31,
- "method": "POST",
- "token": "eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9",
- "tokenType": null,
- "grantType": null,
- "redirectUri": null,
- "scope": null,
- "action": "UPDATE",
- "active": true
}, - "timestamp": 1591458128186
}Endpoint para atualizar webhook
Esse endpoint serve para atualizar registro de webhook de uma empresa parceira.
path Parameters
| associateCompanyId required | integer ID da emrpesa parceira |
| id required | integer ID do webhook |
header Parameters
| token required | string token API de admin |
Request Body schema: application/json
Objeto com informações a respeito do webhook.
| method required | string Metodo do serviço externo. |
| url required | string URL do serviço externo. |
| action required | string Ação do serviço externo. |
Responses
Request samples
- Payload
- Bash
{- "method": "DELETE",
- "action": "CHANGE_STATUS"
}Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": {
- "id": 31,
- "method": "POST",
- "token": "eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9",
- "tokenType": null,
- "grantType": null,
- "redirectUri": null,
- "scope": null,
- "action": "UPDATE",
- "active": true
}, - "timestamp": 1591458128186
}Endpoint para mudar status webhook
Esse endpoint serve para mudar status do registro de webhook de uma empresa parceira.
path Parameters
| id required | integer ID do webhook |
header Parameters
| token required | string token API de admin |
Responses
Request samples
- Bash
curl "https://api.conexasaude.com.br/associate-company/webhook/32" \ -H "token: SEU_API_TOKEN"
Response samples
- 200
- default
{- "status": "200",
- "msg": null,
- "object": true,
- "timestamp": 1591458128186
}