Git Product home page Git Product logo

processoseletivo_st-it1's Introduction

processoSeletivo_ST-IT

API ST IT

O API ST IT foi disponibiliza para vendedores obterem acesso aos produtos do sistema conforme o seu nivel de acesso.

As dúvidas e solicitações, relacionadas ao acesso da API, podem ser enviadas para o e-mail [email protected].

Dependências

  • Express
    • npm install Express
  • readLine (nativo)
  • jsonwebtoken
    • npm install jsonwebtoken

Recursos disponíveis para acesso via API:

Métodos

Requisições para a API devem seguir os padrões:

Método Descrição
POST Utilizar para iniciar sessão autenticada.
GET Retorna um ou mais registros de produtos de acordo com seu level.

Respostas

Código Descrição
200 Requisição executada com sucesso (success).
400 Erros de validação ou os campos informados não existem no sistema.
401 Dados de acesso inválidos.
404 Registro pesquisado não encontrado (Not found).

Return Products

As ações de Return Products permitem o envio dos seguintes parâmetros:

Parâmetro Descrição
organization Filtra dados pela organização.
tag Especificar qual produto dentro da organização deve ser retornado.

Autenticação - JWT

Nossa API utiliza Token Authentication como forma de autenticação/autorização.

Para utilizar o Token Authentication, você precisará:

  1. Utilizar uma das contas contidas no arquivo users.json enviando:

    • Email;
    • Password;
  2. Receber um client_id e client_secret, utilizados na solicitação de acesso;

Solicitando tokens de acesso

Através da URL http://localhost:3003/login nos autenticamos.

  • Request (application/json)

  • Response 200

    • Body

      { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IlF5b0VkcWJmMld5emVSdGoiLCJpYXQiOjE2MjQ5MDI3NDYsImV4cCI6MTYyNDk4OTE0Nn0.Nq6FIt72wp99Fv7hqsEqb8qt-sTrL_yC9nuF_dFTQfI" }

O Token é valido por 24Hrs.

Requisição de produtos

Nossa API utiliza parametros e querystrings para definir o que será retornado.

Para utilizar esse recurso de forma correta, você precisará:

  1. Token dentro do seu prazo de validade;
  2. Permissão para a organization passada como parametro na URL;

Retornando Products

Através da URL http://localhost:3003/products/organizationName?tag=<tag1>

  • Request (application/json)

    • Body

    • Authorization

      • type = Bearer
      • Token Ex: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IlF5b0VkcWJmMld5emVSdGoiLCJpYXQiOjE2MjQ4NDI5ODEsImV4cCI6MTYyNDkyOTM4MX0.a2SoXCl78eVkFPKeXfdM_WVXqj9VmX4shbSnMsLypkg
  • Response 200

    • Body

      { "total": , "products": [ , , , ... ] }

Ex: URL http://localhost:3003/products/Toys?tag=Practical

  • Response 200

    • Body

      { "total": 7, "products": [ "Handmade Steel Bike", "Tasty Rubber Chips", "Practical Fresh Keyboard", "Practical Fresh Keyboard", "Sleek Fresh Computer", "Licensed Frozen Cheese", "Unbranded Frozen Mouse" ] }

Observações Importantes

Infelismente tive um problema com o estado da busca dos dados no arquivo products.txt, que ao realizar a segunda requisição não é feito a busca linha a linha do arquivo novamente, impossibilitando assim a alteração do resultado. A alteração só é feita depois de reiniciar o servidor e executar o primeiro request com os novos parametros.

processoseletivo_st-it1's People

Contributors

vinyhebert avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.