Projeto API do Ton

As requisições podem ser feitas a partir de https://ton-api-1211.herokuapp.com/

Contexto

Este projeto trata-se de uma API das maquininhas do Ton e todos seus endpoints seguem os princípios REST.

Nela, é possível fazer uma requisição que retorna todos os dados, assim como uma requisição por ID que retorna somente o produto especificado.

⚠️ Todos os dados da API são de propriedade da empresa Stone Co. e foram usados apenas para fins de aprendizado.

Tecnologias usadas

Instalando dependências

npm install

Executando aplicação

1. Execute o comando:

A porta 3000 é utilizada para acessar a aplicação por padrão.

npm start

Endpoints

GET /

Retorna a lista de todos os produtos:

https://ton-api-1211.herokuapp.com/

[
  {
    "id": "t1",
    "title": "Maquininha T1",
    "price": 94.8,
    "thumbnail": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/frontview/t1.png",
    "thumbnailAlt": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/sideview/t1.png",
        "details": [
      {
        "icon": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/icons/calendar.png",
        "text": "Receba suas vendas em 1 dia útil"
      },
      ...
    ]
  },
  ...
]

GET /:id

Retorna os detalhes do produto baseado no id da rota. Exemplo quando o id é igual a t2:

https://ton-api-1211.herokuapp.com/t2

{
  "id": "t2",
  "title": "Maquininha T2+",
  "price": 166.8,
  "thumbnail": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/frontview/t2.png",
  "thumbnailAlt": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/sideview/t2.png",
  "details": [
    {
      "icon": "https://raw.githubusercontent.com/gugadolzan/ton-api/main/assets/icons/calendar.png",
      "text": "Receba suas vendas em 1 dia útil"
    },
    ...
  ]
},

Lista de ids disponíveis:

1. t1
2. t1-chip
3. t2
4. t3

Contato

Referências

• Conventional Commits
• Deploying Typescript Node.js applications to Heroku (with static files)
• Maquininha de Cartão de Crédito - Peça sua Maquineta | Ton