Integration Service - MetCare
Bem-vindo à documentação da API do Integration Service. Este serviço permite integrar o seu sistema com a plataforma MetCare através de uma API REST, envio de notificações e webhooks em tempo real.
Nesta documentação
| Tópico | Descrição |
|---|---|
| Subscrições | Listar e consultar subscrições (paginação, filtros, exemplos). |
| Notificações | Enviar notificações por email, SMS e push. |
| Webhooks | Receber eventos em tempo real (subscrições, pagamentos, notificações). |
Visão geral
O Integration Service oferece:
- API REST — Consulta de subscrições e dados relacionados
- Notificações — Envio por email, SMS e push (por utilizador, plano ou broadcast)
- Webhooks — Eventos em tempo real (subscrições, pagamentos, notificações)
- Paginação — Cursor-based pagination para grandes volumes de dados
Referência rápida
Base URL
A API utiliza a versão v1.
| Ambiente | Base URL |
|---|---|
| Sandbox | https://integration.met-care.com/sandbox/v1 |
| Produção | https://integration.met-care.com/v1 |
Autenticação
- Método: Bearer token no header
Authorization - Obtenção de tokens: Solicitar por email em developers@met-care.com (sandbox e produção)
Endpoints disponíveis
Informações do serviço
GET /v1/— Estado do serviço e versão da API
Resposta (200):
{
"data": {
"name": "Integration Service",
"description": "Integration Service for Met Care",
"version": "1.0.0",
"timestamp": "2026-01-15T10:30:00Z",
"status": "active"
}
}
Exemplo de chamada (JavaScript, PHP, Python)
JavaScript:
const BASE_URL = 'https://integration.met-care.com/v1';
const API_TOKEN = 'YOUR_TOKEN';
async function getServiceInfo() {
const response = await fetch(`${BASE_URL}/`, {
headers: { 'Authorization': `Bearer ${API_TOKEN}` }
});
return response.json();
}
PHP:
$baseUrl = 'https://integration.met-care.com/v1';
$apiToken = 'YOUR_TOKEN';
$ch = curl_init($baseUrl . '/');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiToken,
'Content-Type: application/json'
]
]);
$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);
Python:
import requests
BASE_URL = 'https://integration.met-care.com/v1'
API_TOKEN = 'YOUR_TOKEN'
def get_service_info():
response = requests.get(
f'{BASE_URL}/',
headers={'Authorization': f'Bearer {API_TOKEN}'}
)
response.raise_for_status()
return response.json()
Códigos de erro e formato
| Código HTTP | Descrição |
|---|---|
200 |
Sucesso |
400 |
Erro de validação ou requisição inválida |
401 |
Não autenticado |
403 |
Não autorizado |
404 |
Recurso não encontrado |
500 |
Erro interno do servidor |
Formato de erro:
{
"error": {
"code": "VALIDATION_ERROR",
"message": "descrição do erro"
}
}
Limites e boas práticas
-
Rate limit: 1000 requisições por minuto por cliente
(Headers:X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset) -
Use paginação em listagens; evite obter todos os registos de uma vez.
- Use filtros de data (ex.:
updated_since) para sincronização incremental. - Implemente retry com exponential backoff em erros temporários.
- Valide sempre a assinatura dos webhooks recebidos.
- Use cache quando fizer sentido, respeitando timestamps de atualização.
Suporte
- Email: developers@met-care.com
- Tokens (sandbox e produção), dúvidas de integração e documentação.
Dev
- Aureliano Nunes
Versão da API: 1.0.0 · Última atualização: Janeiro 2026