Logo

Primeiros Passos

Faça sua primeira chamada à API Sinapse e comece a integrar

Primeiros Passos com a API Sinapse

Este guia vai ajudá-lo a fazer sua primeira chamada bem-sucedida à API Sinapse em poucos minutos.

O que você precisa

Antes de começar, certifique-se de ter:

Email e senha - Para criar sua conta no Sinapse Cliente HTTP - curl, Postman, ou biblioteca HTTP em sua linguagem Conhecimento básico - JSON e conceitos de API REST

URL Base da API

Todas as chamadas à API devem usar a seguinte URL base:

Base URL: https://api.sinapse.org.br/v1

Todos os endpoints mencionados nesta documentação são relativos a esta URL.

Passo 1: Criar sua Conta

Primeiro, você precisa criar uma conta no Sinapse:

curl -X POST https://api.sinapse.org.br/v1/usuarios/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "senha": "SenhaForte123!",
    "nome": "Seu Nome Completo",
    "cpf": "123.456.789-00",
    "telefone": "(11) 98765-4321"
  }'
import requests

url = "https://api.sinapse.org.br/v1/usuarios/signup"

dados = {
    "email": "[email protected]",
    "senha": "SenhaForte123!",
    "nome": "Seu Nome Completo",
    "cpf": "123.456.789-00",
    "telefone": "(11) 98765-4321"
}

response = requests.post(url, json=dados)
print(response.json())
const dados = {
  email: "[email protected]",
  senha: "SenhaForte123!",
  nome: "Seu Nome Completo",
  cpf: "123.456.789-00",
  telefone: "(11) 98765-4321"
};

fetch('https://api.sinapse.org.br/v1/usuarios/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(dados)
})
.then(response => response.json())
.then(data => console.log(data));

Requisitos da senha:

  • Mínimo 8 caracteres
  • Pelo menos 1 letra maiúscula
  • Pelo menos 1 letra minúscula
  • Pelo menos 1 número
  • Pelo menos 1 caractere especial

Passo 2: Fazer Login

Após criar sua conta, faça login para obter seu token de acesso:

curl -X POST https://api.sinapse.org.br/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "senha": "SuaSenhaForte123!"
  }'
import requests

url = "https://api.sinapse.org.br/v1/auth/login"

credenciais = {
    "email": "[email protected]",
    "senha": "SuaSenhaForte123!"
}

response = requests.post(url, json=credenciais)

if response.status_code == 200:
    dados = response.json()
    access_token = dados['access_token']
    refresh_token = dados['refresh_token']
    print(f"Login realizado! Token: {access_token[:20]}...")
else:
    print(f"Erro no login: {response.status_code}")
async function fazerLogin() {
  const credenciais = {
    email: "[email protected]",
    senha: "SuaSenhaForte123!"
  };
  
  try {
    const response = await fetch('https://api.sinapse.org.br/v1/auth/login', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      },
      body: JSON.stringify(credenciais)
    });
    
    if (response.ok) {
      const dados = await response.json();
      localStorage.setItem('access_token', dados.access_token);
      localStorage.setItem('refresh_token', dados.refresh_token);
      console.log('Login realizado com sucesso!');
    } else {
      console.error('Erro no login:', response.status);
    }
  } catch (error) {
    console.error('Erro:', error);
  }
}

Resposta de Sucesso

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 3600,
  "user": {
    "id": 123,
    "email": "[email protected]",
    "nome": "Seu Nome Completo"
  }
}

Passo 3: Primeira Chamada Autenticada

Agora use o token para fazer uma chamada autenticada:

# Buscar seus dados de perfil
curl -X GET https://api.sinapse.org.br/v1/usuarios/me \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"
# Buscar seus dados de perfil
headers = {
    "Authorization": f"Bearer {access_token}"
}

response = requests.get(
    "https://api.sinapse.org.br/v1/usuarios/me",
    headers=headers
)

if response.status_code == 200:
    perfil = response.json()
    print(f"Olá, {perfil['nome']}!")
    print(f"Email: {perfil['email']}")
    print(f"Permissões: {', '.join(perfil['permissoes'])}")
// Buscar seus dados de perfil
const token = localStorage.getItem('access_token');

fetch('https://api.sinapse.org.br/v1/usuarios/me', {
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
.then(response => response.json())
.then(perfil => {
  console.log(`Olá, ${perfil.nome}!`);
  console.log(`Email: ${perfil.email}`);
  console.log(`Permissões: ${perfil.permissoes.join(', ')}`);
});

Próximos Passos

Agora que você está autenticado, explore as funcionalidades da API:

1. Gerenciar seu Perfil

# Atualizar seus dados
curl -X PUT https://api.sinapse.org.br/v1/usuarios/{seu_id} \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "telefone": "(11) 91234-5678",
    "cargo": "Analista de Dados"
  }'

2. Consultar Agravos de Saúde

# Listar casos de dengue em São Paulo
curl -X GET "https://api.sinapse.org.br/v1/agravos/casos?tipo=dengue&estado=SP" \
  -H "Authorization: Bearer SEU_TOKEN"

3. Trabalhar com Grupos e Permissões

# Ver seus grupos
curl -X GET https://api.sinapse.org.br/v1/usuarios/{seu_id}/grupos \
  -H "Authorization: Bearer SEU_TOKEN"

Renovar Token

Quando seu token expirar (após 1 hora), use o refresh token:

curl -X POST https://api.sinapse.org.br/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{
    "refresh_token": "SEU_REFRESH_TOKEN"
  }'

Problemas Comuns

Próximas Leituras

On this page