{"id":28226652,"url":"https://github.com/dsk-david/sipapi","last_synced_at":"2026-04-12T02:35:23.552Z","repository":{"id":229700018,"uuid":"777416109","full_name":"DsK-David/sipAPI","owner":"DsK-David","description":"SIP é uma api basica que pode funcionar como um sistema de pagamento,simulando uma estrutura de um sistema interbancario de pagamentos","archived":false,"fork":false,"pushed_at":"2024-03-25T20:15:46.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T08:48:52.008Z","etag":null,"topics":["api","js","json","nodejs","pagamento","payment","server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DsK-David.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-25T20:11:05.000Z","updated_at":"2024-03-25T20:15:09.000Z","dependencies_parsed_at":"2024-03-25T21:32:21.143Z","dependency_job_id":"51475650-ff2f-48f7-a85a-cfac932b02f2","html_url":"https://github.com/DsK-David/sipAPI","commit_stats":null,"previous_names":["dsk-david/sipapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DsK-David/sipAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FsipAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FsipAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FsipAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FsipAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DsK-David","download_url":"https://codeload.github.com/DsK-David/sipAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DsK-David%2FsipAPI/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31702580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"online","status_checked_at":"2026-04-12T02:00:06.763Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","js","json","nodejs","pagamento","payment","server"],"created_at":"2025-05-18T12:09:13.728Z","updated_at":"2026-04-12T02:35:23.532Z","avatar_url":"https://github.com/DsK-David.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentação da API SIP\n\nEsta documentação detalha a API SIP, que permite a criação, consulta e manipulação de usuários e transferências em um sistema de pagamentos. A API é construída com Node.js e Express, e utiliza SQLite como banco de dados.\n\n\n## Endpoints\n\n### GET /api/users\n\n- **Descrição:** Retorna uma lista de todos os usuários registrados no sistema.\n- **Parâmetros:** Nenhum.\n- **Resposta:** Um array de objetos, onde cada objeto representa um usuário com os seguintes campos:\n - `id`: Identificador único do usuário.\n - `nome`: Nome do usuário.\n - `saldo`: Saldo atual do usuário.\n - `numero_conta`: Número da conta do usuário.\n\n### GET /api/users/:numero_conta\n\n- **Descrição:** Retorna detalhes de um usuário específico com base no número da conta.\n- **Parâmetros:** `numero_conta` (string) - O número da conta do usuário.\n- **Resposta:** Um objeto representando o usuário com os campos `id`, `nome`, `saldo` e `numero_conta`.\n\n### GET /api/users/nome/:nome\n\n- **Descrição:** Retorna detalhes de um usuário específico com base no nome.\n- **Parâmetros:** `nome` (string) - O nome do usuário.\n- **Resposta:** Um objeto representando o usuário com os campos `id`, `nome`, `saldo` e `numero_conta`.\n\n### GET /api/payment/:nome/\n\n- **Descrição:** Retorna uma lista de todas as transferências realizadas pelo usuário especificado.\n- **Parâmetros:** `nome` (string) - O nome do usuário.\n- **Resposta:** Um array de objetos, onde cada objeto representa uma transferência com os campos `id`, `usuario`, `valor`, `status` e `data`.\n\n### POST /api/users\n\n- **Descrição:** Cria um novo usuário no sistema.\n- **Parâmetros:** Corpo da requisição (JSON) com os campos `nome` e `saldo`.\n- **Resposta:** Um objeto representando o novo usuário com os campos `id`, `nome`, `saldo` e `numero_conta`.\n\n### POST /api/payment/:numero_conta\n\n- **Descrição:** Realiza uma transferência para o usuário especificado.\n- **Parâmetros:** `numero_conta` (string) - O número da conta do usuário. Corpo da requisição (JSON) com o campo `valor`.\n- **Resposta:** Um objeto com a mensagem de sucesso e o `novoSaldo` do usuário após a transferência.\n\n### DELETE /api/users/clear\n\n- **Descrição:** Remove todos os usuários do banco de dados.\n- **Parâmetros:** Nenhum.\n- **Resposta:** Um objeto com a mensagem de sucesso.\n\n## Exemplos de Uso\n\n### Criar um novo usuário\n\n```json\nPOST /api/users\n{\n \"nome\": \"João\",\n \"saldo\": 1000\n}\n```\n\n### Realizar uma transferência\n\n```json\nPOST /api/payment/123456\n{\n \"valor\": 500\n}\n```\n## Como Rodar o Projeto\n\n1. **Clone o Repositório:**\n   Primeiro, clone o repositório do projeto para sua máquina local.\n   ```\n   git clone https://github.com/DsK-David/sipAPI\n   ```\n\n2. **Instale as Dependências:**\n   Navegue até a pasta do projeto e instale as dependências necessárias usando o npm (Node Package Manager).\n   ```\n   cd sipAPI\n   npm install\n   ```\n   \n\n3. **Inicie o Servidor:**\n   Inicie o servidor de desenvolvimento com o seguinte comando:\n   ```\n   npm run api\n   ou\n   yarn run api\n   ```\n   O servidor iniciará e estará ouvindo na porta especificada no arquivo `index.js` ou na porta padrão 3000 se nenhuma variável de ambiente `PORT` for definida.\n\n\n\n## Como Contribuir\n\nContribuições são bem-vindas! Aqui estão algumas dicas sobre como você pode contribuir para o projeto:\n\n1. **Relate Bugs:** Se você encontrar um bug, reporte-o usando o sistema de rastreamento de problemas do projeto. Certifique-se de fornecer detalhes suficientes para que outros desenvolvedores possam reproduzir o problema.\n\n2. **Sugira Melhorias:** Se você tiver uma ideia para melhorar a API ou adicionar novas funcionalidades, abra uma issue descrevendo sua sugestão.\n\n3. **Contribua com Código:** Se você deseja contribuir com código, siga estas etapas:\n   - Faça um fork do repositório.\n   - Crie uma nova branch com um nome descritivo.\n   - Faça suas alterações e adicione testes, se necessário.\n   - Envie um pull request para a branch principal do projeto.\n\n4. **Documentação:** Melhorias na documentação são sempre bem-vindas. Se você acha que a documentação pode ser melhorada ou está faltando informações, sinta-se à vontade para contribuir.\n\n## Considerações\n\nEsta API é projetada para ser simples e eficiente, permitindo a gestão de usuários e transferências de forma clara e direta. A documentação aqui apresentada fornece uma visão geral dos endpoints disponíveis, facilitando a integração com outras aplicações ou serviços.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsk-david%2Fsipapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsk-david%2Fsipapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsk-david%2Fsipapi/lists"}