Skip to content

Commit 67ef2f4

Browse files
authored
Add new sections (#9)
* Linting and stuff * Update lint.yml * Add contributing.md * Fix broken link * Fix linting errors * Fix placeholder being interpreted other way * Tweak README * Remove English translation * Add more sections * Delete .github/workflows/lint.yml This won't work for us. It assumes content is in English * Update headings and toc * Refine table of contents and update terminology in README --------- Co-authored-by: Paulo Phagula <PauloPhagula@users.noreply.github.com>
1 parent b927d0b commit 67ef2f4

4 files changed

Lines changed: 114 additions & 79 deletions

File tree

.github/workflows/linkrot.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Linkrot
2+
on:
3+
schedule:
4+
- cron: '0 13 * * MON'
5+
workflow_dispatch:
6+
jobs:
7+
check:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
- name: Fix links
12+
uses: tmcw/notfoundbot@v2.3.1
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 80 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,61 +4,126 @@
44
55
## Conteúdo
66

7+
- [O que é a Open API do M-Pesa?](#o-que-é-a-open-api-do-m-pesa)
8+
- [Como posso integrar?](#como-posso-integrar)
9+
- [Processo](#processo)
710
- [Recursos](#recursos)
811
- [Bibliotecas](#bibliotecas)
912
- [Artigos](#artigos)
1013
- [Vídeos](#vídeos)
1114
- [Regulamentação](#regulamentação)
1215
- [Exemplo de E-mail de Solicitação](#exemplo-de-e-mail-de-solicitação)
16+
- [Como contribuir](#como-contribuir)
17+
18+
## O que é a Open API do M-Pesa?
19+
20+
A Open API do M-Pesa é um conjunto de interfaces programáveis (APIs)
21+
disponibilizadas pela Vodacom Moçambique que permite a integração de **aplicações**,
22+
sistemas ou plataformas com os serviços financeiros digitais do M-Pesa.
23+
24+
O objetivo principal da Open API é permitir que empresas, desenvolvedores e instituições automatizem operações financeiras, como:
25+
26+
- Colecta de pagamentos (cobrança)
27+
- Envio de fundos para clientes ou fornecedores
28+
- Consultas de transações
29+
- Estornos (reversões) de pagamentos
30+
- Validação de contas
31+
32+
## Como posso integrar?
33+
34+
A integração pode ser feita de dois modos:
35+
36+
1. Directo, onde o desenvolvedor faz a intelergicação diretamente com a API do M-Pesa, utilizando as credenciais fornecidas pela Vodacom Moçambique.
37+
2. Usando um agregador, que é uma empresa ou serviço que já possui integração com a API do M-Pesa e oferece uma interface simplificada para desenvolvedores.
38+
39+
O processo para a integração directa está descrito abaixo na secção [Processo](#processo).
40+
41+
## Processo
42+
43+
Em linhas gerais o processo de integração com a API Publica do M-Pesa envolve as seguintes etapas principais:
44+
45+
1. Criação de Conta e Integração no Ambiente de Desenvolvimento
46+
47+
A primeira etapa consiste em criar uma conta no portal de desenvolvedores do M-Pesa, disponível em: https://developer.mpesa.vm.co.mz.
48+
Após o registo, será possível integrar o seu sistema ao ambiente de desenvolvimento, onde poderá testar todas as operações suportadas (cobrança, estorno, consulta, etc.).
49+
Neste ambiente, também terá acesso às API keys necessárias para a configuração e testes iniciais.
50+
51+
2. Validação e Pedido de Acesso ao Ambiente de Produção
52+
53+
Assim que os testes forem concluídos com sucesso, deverá contactar a equipa do M-Pesa através do email: M-Pesa.business@vm.co.mz solicitando a migração para o ambiente de produção.
54+
Neste ponto, será necessário cumprir com determinados requisitos legais, que variam conforme o tipo de entidade (pessoa singular, empresa, organização, etc.).
55+
Os detalhes estão disponíveis no ficheiro de requisitos legais fornecido na secção de [recursos](#recursos).
56+
57+
3. Formalização do Acordo e Treinamento
58+
59+
Em colaboração com a equipa do M-Pesa, deverá:
60+
61+
- Enviar a documentação exigida;
62+
- Negociar as comissões aplicáveis;
63+
- Assinar o contrato de prestação de serviços;
64+
- Proceder à abertura de uma conta empresa no M-Pesa;
65+
- Participar numa formação sobre a gestão da conta e utilização do sistema, incluindo: gestão de utilizadores, reversões de transações, análise de relatórios, entre outros aspetos operacionais do backoffice.
66+
67+
4. Integração no Ambiente de Produção
68+
69+
Após a conclusão das etapas anteriores, será fornecido o acesso às *API keys* do ambiente de produção. Com estas credenciais, poderá configurar o seu sistema para iniciar as operações reais.
70+
71+
5. Início das Operações Comerciais
72+
73+
Com a integração finalizada e os acessos configurados, poderá começar a explorar e operar com a plataforma de pagamentos M-Pesa de forma plena.
1374

1475
## Recursos
1576

16-
- https://www.vm.co.mz/m-pesa/artigo/api-aberta-do-m-pesa - Descrição do serviço da Open API do M-Pesa
17-
- https://developer.mpesa.vm.co.mz/ - Portal do Desenvolvedor M-Pesa
18-
- [Requisitos de Acesso à API de Produção e Checklist](https://github.com/PauloPhagula/awesome-mpesa/files/13706274/Checklist.para.Pessoas.Colectivas.-.Versao.1.7.-.2022.pdf)
77+
- [Descrição do serviço da Open API do M-Pesa](https://www.vm.co.mz/m-pesa/artigo/api-aberta-do-m-pesa) - Documentação oficial do serviço.
78+
- [Portal do Desenvolvedor M-Pesa](https://developer.mpesa.vm.co.mz/) - Portal oficial para desenvolvedores.
79+
- [Requisitos de Acesso à API de Produção e Checklist](https://github.com/PauloPhagula/awesome-mpesa/files/13706274/Checklist.para.Pessoas.Colectivas.-.Versao.1.7.-.2022.pdf) - Documento oficial com requisitos e checklist para acesso à API.
1980

2081
## Bibliotecas
2182

22-
- [mpesasdk](https://github.com/realdm/mpesasdk) - SDK não oficial com o objetivo de facilitar a integração com a API de pagamentos da Vodacom Moçambique em aplicativos Android.
23-
- [mpesa-node-api](https://github.com/thatfiredev/mpesa-node-api) - Biblioteca NodeJS para a API do M-Pesa (Moçambique).
83+
- [mpesasdk](https://github.com/realdm/mpesasdk) - SDK não oficial para facilitar a integração com a API de pagamentos da Vodacom Moçambique em aplicativos Android.
84+
- [mpesa-node-api](https://github.com/thatfiredev/mpesa-node-api) - Biblioteca Node.js para a API do M-Pesa (Moçambique).
2485
- [mpesa-php-api](https://github.com/abdulmueid/mpesa-php-api) - Biblioteca PHP para a API do M-Pesa (Moçambique).
2586
- [mpesa_sdk_dart](https://github.com/realrgt/mpesa_sdk_dart) - Biblioteca Dart | Flutter para a API do M-Pesa (Moçambique).
2687
- [mpesa-sdk-ios](https://github.com/AlgyJr/MpesaSDK.git) - Biblioteca Swift | iOS para a API do M-Pesa (Moçambique).
2788
- [mpesa-wordpress-plugin](https://github.com/herquiloidehele/mpesa-wordpress-plugin) - Plugin de pagamento Vodacom M-PESA para WooCommerce em Moçambique.
2889
- [wc-mpesa-payment-gateway](https://github.com/turbohost/wc-mpesa-payment-gateway) - Gateway de Pagamento Vodacom M-Pesa para WooCommerce.
29-
- [karson/mpesa-php-sdk](https://github.com/karson/mpesa-php-sdk) - Um SDK PHP para as novas APIs RESTful do Vodacom M-Pesa em Moçambique.
30-
- [paymentsds](https://github.com/paymentsds) - Um conjunto de SDKs projectados para ajudar empresas a integrar operações do M-Pesa em seus aplicativos.
31-
- [mpesa-sdk-rust](https://github.com/GraHms/mpesa-rust-sdk) - Biblioteca Rust para interagir com a API do M-Pesa, simplificando integrações de pagamento B2C e mais.
90+
- [karson/mpesa-php-sdk](https://github.com/karson/mpesa-php-sdk) - SDK PHP para as APIs RESTful do Vodacom M-Pesa em Moçambique.
91+
- [paymentsds](https://github.com/paymentsds) - Conjunto de SDKs para integração de operações do M-Pesa em aplicativos.
92+
- [mpesa-sdk-rust](https://github.com/GraHms/mpesa-rust-sdk) - Biblioteca Rust para interagir com a API do M-Pesa, simplificando integrações de pagamento B2C.
3293

3394
## Artigos
3495

3596
- [Mpesa, mais do que uma API…](https://medium.com/android-dev-moz/mpesa-mais-do-que-uma-api-bc2ead953cc2) - Artigo descrevendo o processo de integração, desde a criação da conta até a produção.
36-
- [Um olhar sobre a API do M-Pesa](https://medium.com/android-dev-moz/um-olhar-sobre-a-api-do-m-pesa-688fd6abe351) - Artigo que fornece uma visão geral da API do ponto de vista do desenvolvedor.
37-
- [Decreto 59/2023 - destaques & implicações](https://www.linkedin.com/pulse/decreto-592023-destaques-implica%2525C3%2525A7%2525C3%2525B5es-m%2525C3%2525A1rio-j%2525C3%2525BAnior-snpzf%3FtrackingId=tVAdOsDNxQFQ8YzQMotn4w%253D%253D/?trackingId=tVAdOsDNxQFQ8YzQMotn4w%3D%3D)
97+
- [Um olhar sobre a API do M-Pesa](https://medium.com/android-dev-moz/um-olhar-sobre-a-api-do-m-pesa-688fd6abe351) - Visão geral da API do ponto de vista do desenvolvedor.
98+
- [Decreto 59/2023 - destaques & implicações](https://www.linkedin.com/pulse/decreto-592023-destaques-implica%2525C3%2525A7%2525C3%2525B5es-m%2525C3%2525A1rio-j%2525C3%2525BAnior-snpzf%3FtrackingId=tVAdOsDNxQFQ8YzQMotn4w%253D%253D/?trackingId=tVAdOsDNxQFQ8YzQMotn4w%3D%3D) - Análise do decreto e suas implicações.
3899

39100
## Vídeos
40101

41-
- [Implementar Mpesa em Android (Dario Mungoi mpesaSDK)](https://www.youtube.com/watch?v=RtY67lsb5TY)
102+
- [Implementar Mpesa em Android (Dario Mungoi mpesaSDK)](https://www.youtube.com/watch?v=RtY67lsb5TY) - Tutorial de implementação do M-Pesa em aplicativos Android.
42103

43104
## Regulamentação
44105

45-
- [Lei das Transações Eletrônicas](https://github.com/PauloPhagula/awesome-mpesa/files/12642436/Lei-das-Transaccoes-eletronicas.pdf)
46-
- [Regulamento de Registro e Licenciamento BR_206_I_SERIE_2023](https://github.com/PauloPhagula/awesome-mpesa/files/14340618/Regulamento.de.Registo.e.Licenciamento.BR_206_I_SERIE_2023.pdf)
106+
- [Lei das Transações Eletrônicas](https://github.com/PauloPhagula/awesome-mpesa/files/12642436/Lei-das-Transaccoes-eletronicas.pdf) - Documento oficial da lei.
107+
- [Regulamento de Registro e Licenciamento BR_206_I_SERIE_2023](https://github.com/PauloPhagula/awesome-mpesa/files/14340618/Regulamento.de.Registo.e.Licenciamento.BR_206_I_SERIE_2023.pdf) - Regulamento oficial de registro e licenciamento.
47108

48109
## Exemplo de E-mail de Solicitação
49110

50111
Para: M-Pesa.business@vm.co.mz
51-
Assunto: Acesso à Open API para [Nome da Empresa]
112+
Assunto: Acesso à Open API para {Nome da Empresa}
52113
De: Responsável pelo Negócio
53114
Corpo:
54115

55116
```txt
56117
Saudações, equipe M-Pesa,
57118
58-
Espero que este e-mail os encontre bem. Meu nome é [Seu Nome] e estou entrando em contato como responsável pelo negócio para solicitar formalmente o acesso à Open API.
119+
Espero que este e-mail os encontre bem. Meu nome é {Seu Nome} e estou entrando em contato como responsável pelo negócio para solicitar formalmente o acesso à Open API.
59120
Em anexo, envio todos os documentos necessários especificados no Checklist fornecido. Certifiquei-me de incluir todas as informações exigidas para sua análise.
60121
Aguardo instruções sobre os próximos passos do processo.
61122
Obrigado pela atenção e retorno rápido.
62123
63124
Atenciosamente,
64125
```
126+
127+
## Como contribuir
128+
129+
Por favor, leia o [guia de contribuição](contributing.md).

README_EN-US.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

contributing.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contribuindo
2+
3+
Todos os tipos de contribuições são bem-vindas!
4+
5+
- Documentação incorreta? Erros técnicos acontecem o tempo todo.
6+
- Há algo que você não entendeu imediatamente? A explicação foi muito complicada?
7+
- Outras sugestões de melhoria? Melhor redação? Erros de digitação? Links quebrados?
8+
- Quer adicionar livrarias? Por favor, certifique-se de que elas já tenham algumas estrelas.
9+
Existem novos livrarias todos os dias e não posso testá-los todos,
10+
então confio na "prova social" como indicador de utilidade.
11+
12+
Por favor, reporte _qualquer coisa_ que pareça errada para você
13+
[criando uma issue](https://github.com/PauloPhagula/awesome-mpesa/issues/new).
14+
15+
Se você quiser corrigir você mesmo, abra um
16+
[pull request](https://help.github.com/categories/collaborating-with-issues-and-pull-requests).
17+
Não se preocupe muito com a formatação das suas mensagens de commit, o patch
18+
real é mais importante.
19+
20+
Obrigado por contribuir! 🎉

0 commit comments

Comments
 (0)