API.md

CBTRG API

API com foco na integração dos sistemas do Conselho Brasileiro de Terapia de Reprocessamento Generativo com outros sistemas externos.

O endereço de origem é https://api.cbtrg.com.br/ para todos endpoints abaixo.

• GET /api/v1/membership/:register_number

  Retorna dados públicos sobre uma filiação. Dados básicos: Número de Registro e Validade da Filiação. Não serão retornados outros dados para proteção dos dados do filiado.

  Endpoint público, sem necessidade de autenticação

  Retorno esperado:

  {
    "register_number": "0001",
    "valid_until": "2021-12-31"
  }

  Em caso de erro:

  {
    "error": "Not found"
  }

• POST /api/v1/auth/sign_in

  Faz login to usuário.

  Endpoint público, sem necessidade de autenticação

  Payload/Body esperado:

  {
    "email": "email",
    "password": "pass"
  }

  Retorno esperado:

  {
      "data": {
          "email": "email@oi.com",
          "uid": "email@oi.com",
          "id": 1,
          "name": "You name",
          "doc_number": "",
          "person_type": "",
          "phone_number": "",
          "admin": true,
          "provider": "email"
      }
  }

  Headers vão conter:

  • access-token
  • token-type
  • uid
  • expiry
  • client

  Em caso de erro:

  {
      "success": false,
      "errors": [
          "E-mail ou senha inválidos."
      ]
  }