Altairis.FioBankApi 1.0.0

Knihovna FioBanka-API

This is API for reading list of transactions of Czech bank Fio Banka. The documentation is in Czech, as I expect the audience to know the language.

However, the API itself is in English and contains XML comments in English. Also, it's pretty simple and I believe also quite self-explanatory.

Klient pro načítání seznamu pohybů z API bankovnictví Fio banky.

Instalace

Knihovna je k dispozici na NuGetu jako balíček Altairis.FioBankApi.

Právní doložky

• Tato knihovna je open source pod MIT licencí.
• Tato knihovna dodržuje No Code Of Conduct (NCoC).

API reference

• Logika pojmenování i chování metod vychází z (ne vždy zcela srozumitelné) logiky API Fio banky.
• Pokud API vrátí chybu, vyhodí příslušná metoda HttpRequestException.
• Všechny metody jsou asynchronní a vracejí Task nebo Task<T>.

Třída FioClient

Pro načtení dat z API slouží metody třídy FioClient. Tato třída má jeden konstruktor, který jako argument dostává token, přístupový token k API.

Tato třída spravuje instanci System.Net.Http.HttpClient. Vzhledem k předpokládanému režimu použití (API bude voláno relativně zřídka a ne z několika vláken současně) nepředpokládám problémy popsané v článku HttpClient Guidelines for .NET. Postačuje před použitím vytvořit instanci a po použití ji zase zlikvidovat.

Metoda GetTransactions

Načte seznam transakcí za zvolené období. Všechny overloady jsou asynchronní a vracejí Task<TransactionList>.

• GetTransactions() - vrací seznam transakcí od poslední zarážky.
• GetTransactions(DateOnly dateBegin) - vrací seznam transakcí od určitého data.
• GetTransactions(DateOnly dateBegin, DateOnly dateEnd) - vrací seznam transakcí od-do určitého data.

Na volání této metody je uplatňován rate limiting a mezi jednotlivými voláními musí být přestávka nejméně 30 sekund. Jinak je vrácen stavový kód 409 Conflict a vyhozena HttpRequestException. Typické ošetření tohoto stavu:

try {
    var tl = await api.GetTransactions();
    Console.WriteLine($"OK, account IBAN {tl.Iban}");
} catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.Conflict) {
    Console.WriteLine("Too many requests - API supports only one request per 30 seconds.");
}

Metoda SetCursor

Nastaví zarážku na určenou hodnotu. Je asynchronní a vrací Task.

• SetCursor(string lastKnownId) - nastaví zarážku na ID posledního úspěšně načteného pohybu.
• SetCursor(DateOnly lastFailedDate) - nastaví zarážku na datum posledního neúspěšně načteného dne.

Třída TransactionList

Obsahuje informace o seznamu transakcí (pohybů).

Record TransactionInfo

Obsahuje informaci o konkrétní transakci (pohybu).