Skip to main content

Framework/tookit berbasis pydantic dan FastAPI untuk implementasi SNAP (Standar Nasional Open API Pembayaran) Indonesia

Project description

SNAP-API

Framework/tookit berbasis pydantic dan FastAPI untuk implementasi SNAP (Standar Nasional Open API Pembayaran) Indonesia

Transaksi

Virtual Account:

  1. Inquiry, Service Code '24'
  2. Payment, Service Code '25'

Iya, masih banyak Transaksi yang harus dibuat Modelnya :)

Python

snapapi dibuat dengan menggunakan Python versi 3.8.20, semoga bisa digunakan dibanyak OS yang mungkin masih belum support python terbaru.

snapapi menggunakan type hints yang diverifikasi dengan mypy.

Dependency

SNAP-API membutuhkan module sbb:

  1. pydantic https://pydantic.dev
    Dasar dari validasi model agar sesuai dengan spesifikasi yang telah ditetapkan oleh Bank Indonesia dan ASPI (Asosiasi Sistem Pembayaran Indonesia)

  2. pycryptodome https://www.pycryptodome.org
    Digunakan untuk membuat dan meverifikasi Asymmetric Signature dengan algorithma SHA256withRSA

  3. PyJWT https://pyjwt.readthedocs.io/en/latest
    Dibutuhkan untuk membuat dan meverifikasi Access Token berbasis JWT

  4. fastapi https://fastapi.tiangolo.com
    Lighweight and fast framework API berdasarkan OpenAPI

  5. asyncer https://asyncer.tiangolo.com
    Thin layer module di atas anyio agar membuat sync method (spt class Crypto) menjadi async

Optional

  1. uvicorn https://www.uvicorn.org
    ASGI web server

  2. aiocache https://aiocache.aio-libs.org/en/latest
    Digunakan untuk cache key X-External-Id pada API Transaksi. Backend untuk store keys bisa dipilih antara memcached, redis atau memory

  3. orjson https://github.com/ijl/orjson
    Pengganti yang lebih baik daripada standar json

Cara Pakai

Import class SNAP-API kemudian instantiate sama seperti class FastAPI, karena class IDSAP merupakan subclass dari class FastAPI. Contoh:

app = SNAP-API(
        title='SNAP-API Demo',
        version="0.1.1",
        description="""
### Standar Nasional Open API Pembayaran Versi 1.0.2
> Flow Inbound (Direct): Bank -> API
""")

Silakan lihat direktori app/demo untuk contoh implementasi. Untuk menjalankan aplikasi Demo, silakan baca app/README.md dan ikuti petunjuknya.

Future Development

Module SNAP-API dibuat berdasarkan kebutuhan project profesional developer untuk implementasi SNAP dengan flow Inbound atau Direct; Bank -> API

Bank yang melakukan initiate query (inquiry dan payment) untuk Virtual Account dimana Bill, Virtual Account dan Customer management dilakukan oleh Backend terlepas dari API ini.

Jadi module ini cukup jika digunakan untuk skenario di atas. Agar compliance dengan SNAP, masih banyak skenario yang harus diimplementasi.

Fokus pengembangan module ini adalah:

  1. Mengikuti perkembangan SNAP supaya compliance setiap kali ada versi terbaru.
  2. Implementasi Model lain agar sesuai dengan dokumentasi SNAP, terutama melengkapi fitur Virtual Account.
  3. Refactoring fitur yang sudah ada supaya lebih ringan, tidak terlalu banyak dependency, dan mudah digunakan.
  4. Tambah fitur seperti Logger (agar compliance dengan SNAP), API untuk Backend, dll.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snapapi-0.1.3.tar.gz (30.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snapapi-0.1.3-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file snapapi-0.1.3.tar.gz.

File metadata

  • Download URL: snapapi-0.1.3.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for snapapi-0.1.3.tar.gz
Algorithm Hash digest
SHA256 5b3aa900b91798f009d25b1d6138aaa13e79576322eb8d7da046d0643804849e
MD5 b36e929445eabbf1c5d81cd95ab7739e
BLAKE2b-256 b556012d9855faec4e88acfb64e6e9fc10f915150ca2a37b8dde679766ab9ef1

See more details on using hashes here.

File details

Details for the file snapapi-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: snapapi-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for snapapi-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 80865119223c62670df214d7700f27a7264495a01c345bfcea5262fd006272de
MD5 d51d5357c1240e22e767bd91fecb4841
BLAKE2b-256 2f9e19ac234b9c19881d330baf44163a551741ae0d32394230e5b4a10337c59f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page