1- Esteja cadastrado: tenha uma conta na plataforma de modo que tenhas acesso ao código de autenticação para que o teu site ou aplicativo consiga se comunicar com a API.
2- Cadastre o teu site: Registe o teu site na plataforma para que o mesmo tenha permissão de se autenticar com a API. Para que um site possa se autenticar na API é necessário que a mesma esteja cadastrada na plataforma e que o código de autenticação que a mesma usa seja igual ao proprietário que o registou.
3- Utilize o parámetro de acesso: Para poder se comunicar com a API é necessário que se coloque os seguintes parámetros.
<form action="https://api.fasma.ao/?sudopay_key=tuachave" method="post" enctype="multipart/form-data"></form>
é necessário que no campo form tenha method="POST" e que tenha o enctype="multipart/form-data" .
Também é necessários que no action tenha essa instrução
https://api.fasma.ao/?sudopay_key=tuachave”.
Substitua tuachave pela chave que irás receber após fazer o cadastro.
O imput que vai ter o recibo bancário deve estar da seguite maneira
<input type="file" name="sudopay_file" accept="application/pdf" required/>
é necessário que o campo que vai receber o arquivo a ser validade tenha name="sudopay_file" para
que a API saiba o que validar.
| Código | Descrição |
|---|---|
| 200 | Sucesso |
| 400 | Nenhum ficheiro anexado, o campo do tipo file com name="sudopay_file" não foi encontrado. |
| 403 | Nao se encontra autenticado; a chave de autenticação não existe; ou o site não foi registado pelo proprietario da chave de autenticacao a se utilizar; |
| 404 | O método de requisição não é POST, ou o sudopay_key não representa a chave de autenticação; |
| 406 | O documento é inválido |
| 415 | Ficheiro nao suportado |
| 423 | O documento não representa uma transferencia Bancaria; |
| Nome | Descrição |
|---|---|
| APLICATIVO | Mostra o nome do aplicativo usado como BAI DIRECT ou MULTICAIXA EXPRESS. [Todos] |
| STATUS | Mostra o código de erro ou de successo. [Todos] |
| LOG | Mostra o motivo de algum erro, vem o nome do aplicativo (MULTICAIXA EXPRESS / BAI DIRECT) usado caso nao ocorra nenhum erro. [Todos] |
| B_NOME | Mostra o nome da entidade que recebeu a transferencia (Nome do Beneficiário). [Todos] |
| O_NOME | Mostra o nome da entidade que enviou a transferencia (Nome do ordenante). [BAI DIRECT] |
| B_IBAN | Mostra o nº de IBAN da entidade que recebeu a transferencia (Nº de IBAN do Beneficiário). [Todos] |
| O_IBAN | Mostra o nº de IBAN da entidade que enviou a transferencia (Nº de IBAN do ordenante). [Todos] |
| O_CONTA | Mostra o nº de conta da entidade que enviou a transferencia (Nº de conta do ordenante). [BAI DIRECT] |
| B_BANCO | Mostra o nome do banco da entidade que recebeu a transferencia (Banco do Beneficiário). [BAI DIRECT] |
| B_SWIFT | Mostra o codigo do SWIFT da entidade que recebeu a transferencia (SWIFT do Beneficiário). [BAI DIRECT] |
| O_BANCO | Mostra o nome do banco da entidade que enviou a transferencia (Banco do ordenante). [MULTICAIXA EXPRESS] |
| TRANSACAO | Obtém o número de transação, que é um número único que identifica uma transação bancária, ela pode ser usada para verificar se o mesmo recibo já foi registado. [Todos] |
| MONTANTE | Obtém o valor da transação. [Todos] |
| TIPO | Obtém o tipo de operação que representa o comprovativo. [Todos] |
| DATA | Obtem a data e hora que foi efectuada a transferencia. as suas ramificações são: data(obtem a data), tempo(obtem a hora em horas, minutos, segundos), datahora(obtem a data e a hora o formato depende, se for BAI DIRECT "dd/mm/YYYY hh:mm:ss" | se for MULTICAIXA EXPRESS "YYY-mm-dd hh:mm:ss"), dia(obtem o dia), mes(obtem o mês), ano(obtem o ano), hora(obtem a hora), minuto(obtem o minuto), segundo(obtem o segundo). [Todos] |
<html lang="pt">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>FasmaPay - teste</title>
</head>
<body>
<form action="https://api.fasma.ao/?sudopay_key=tuachave" method="post" enctype="multipart/form-data">
<input type="file" name="sudopay_file" accept="application/pdf" required/>
<button type="submit">validar</button>
</form>
<script>
if (form = document.querySelector('form')) {
//verifica se o botao do tipo submit foi pressionado
form.addEventListener('submit', function (e) {
//cancela a a accão normal do botão submit
e.preventDefault();
//pega todos os dados do formulario e coloca na variavel do tipo FormData
var dados = new FormData(form);
//faz a requisicao com o fetch
fetch(form.action, {
method: form.method,
body: dados
})
.then(res => {
//em caso de erro
if (!res.ok) throw new Error(res.status);
return res.json();
})
.then(data => {
//pegar os parametros necessarios caso for sucesso
alert("sucesso: "+data.OPERACAO);
})
.catch((error) => {
//pegar o codigo de erro caso haja
alert("erro: "+error.message);
});
})
}
</script>
</body>
</html>