Rotas da Ibiapaba
    Rotas da Ibiapaba
    • ⛰️ Doc - API Rotas da Ibiapaba
    • /authentication
      • Autenticação de Usuário
        POST
      • Validação de Acesso
        POST
      • Redefinição de Senha
        POST
      • Alteração de Senha
        PATCH
      • Encerrar Sessão
        POST
      • Renovar tokens
        POST
      • Reenvio de código para email
        POST
    • /accounts
      • Cadastro de Usuário
        POST
      • Listar usuarios
        GET
      • Detalhes do Usuario
        GET
      • Cadastrar chave pix
        POST
      • Atualizar chave pix
        PUT
      • Atualizar dados do usuario
        PUT
      • Deleta dados do usuario
        PUT
    • /categories
      • Listar Categorias
        GET
      • Criar Categoria
        POST
      • Atualizar Categoria
        PUT
      • Excluir Categoria
        DELETE
    • photos
      • EnviarFotoProfile
        POST
      • EnviarGaleriadeFotos
        POST
    • /tickets
      • Validar código
        POST
      • Resgatar um único produto
        POST
      • Listar todos os tickets
        GET
    • /products
      • Cadastrar produto
      • Mostar dados de um produto
      • Atualizar um produto
      • Remover um produto
      • Mostar todos os produtos de um estabelecimento
    • /orders
      • Adicionar Item ao Carrinho
      • Iniciar processo de pagamento de pedido
      • Listar Itens do Carrinho
    • payments
      • Consultar status de pagamento
      • Solicitar retirada de dinheiro
    • /transactions
      • Mostra o resumo de movimentações em dinheiro
      • Mostar todas as transações do estabelecimento
    • /partners
      • Mostar parceiros anunciantes próximos
    • others
      • Cadastrar mensagem de ajuda ao suporte

    ⛰️ Doc - API Rotas da Ibiapaba

    Modelo de resposta (success/ error)#

    Http response#

    Modelo baseado na lib ajax Axios para requisição http.
    Model
    {
      "message": {
        "title": string,
        "text": string
      },
      "success": boolean,
      "status": number,
      "data": <T>
    }
    Error example
    {
      "message": {
        "title": "Erro, usuário não autorizado!",
        "text": "Description"
      },
      "success": false,
      "status": 401,
      "data": null
    }

    Headers recomendados para response#

    "headers": {
      "Content-Type": "application/json; charset=utf-8",
      "Strict-Transport-Security": "max-age=63072000; includeSubDomains; preload",
      "X-Frame-Options": "DENY",
      "X-Content-Type-Options": "nosniff",
      "X-XSS-Protection": "1; mode=block",
      "Referrer-Policy": "no-referrer",
      "Permissions-Policy": "geolocation=(), microphone=()",
      "Access-Control-Allow-Origin": "https://meusite.com",
      "Content-Security-Policy": "default-src 'self'"
    },

    Cabeçalhos de Segurança#

    CabeçalhoPropósito
    Strict-Transport-SecurityObriga o navegador a usar HTTPS. Protege contra downgrade attacks.
    X-Frame-OptionsEvita que sua aplicação seja carregada via. Mitiga clickjacking.
    X-Content-Type-OptionsEvita que o browser tente adivinhar o tipo de conteúdo (MIME sniffing).
    X-XSS-ProtectionAtiva proteção contra XSS em alguns navegadores (antigo, mas ainda útil).
    Referrer-PolicyControla o que é enviado

    Configuração de CORS#

    {
      "origin": ["https://seusite.com", "https://admin.seusite.com"],
      "methods": ["GET", "POST", "PUT", "PATCH", "DELETE"],
      "allowedHeaders": ["Content-Type", "Authorization"],
      "exposedHeaders": ["Content-Length", "X-Kuma-Revision"],
      "credentials": true,
      "maxAge": 86400
    }
    PropriedadeFinalidade
    originLista de domínios autorizados a acessar a API. Bloqueia requisições de outras origens.
    originMétodos HTTP permitidos para essas origens (ex: GET, POST).
    originCabeçalhos que o navegador pode enviar. Protege contra headers inesperados.
    originCabeçalhos que o navegador pode ler na resposta (normalmente ocultos).
    credentialsPermite cookies, tokens de autenticação ou cabeçalhos customizados com a requisição.
    credentials
    Tempo que o navegador pode cachear a resposta da requisição
    (preflight).

    Controle de versões#

    Uso de prefixos para determinar a versão, exemplo: /api/v1/ . Dessa forma, garantimos a consistência entre versões. Deve ser utilizado como pré-fixo para todas as rotas.
    Modificado em 2025-06-11 22:26:37
    Próxima página
    Autenticação de Usuário
    Built with