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

Install package dengan pip.

$ pip install snapapi

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

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.4.tar.gz (31.1 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.4-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snapapi-0.1.4.tar.gz
  • Upload date:
  • Size: 31.1 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.4.tar.gz
Algorithm Hash digest
SHA256 5c3f00b1f2cf82b4edc901c547a9c6c71dfb447d4d4da219320d0b417814a486
MD5 317d1b6b889ef8d06af8dc03bf43ef01
BLAKE2b-256 45d933d82a7451b341a3a28bbce647eb238a329c8c83d920c2893e6ba33ca306

See more details on using hashes here.

File details

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

File metadata

  • Download URL: snapapi-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d5264fd6a5244b96b6c3e71165f0ee2e3f196967adfbf369d615f19c8fd018b0
MD5 875ba3dd054d49121e73ccb0499ecb29
BLAKE2b-256 b313e1c288709a12a9d9d33e198a466307165843b1be317d2c611a68f333f800

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