Giter Club home page Giter Club logo

pt.md-api's Introduction

pt.md-api

Posta Moldovei Terminals API base on pt.md library (https://pt.md)

Prerequisites

  • NodeJS >= v8.x.x

Installation

npm install pt.md-api

Usage

Configuration

cp .env.sample .env

We advice to .env and change JWT_SECRET due to security reasons

Production

npm run start

Production involves pm2 tool usage, thus once started you should run npm run stop to stop the server

Development

npm run start:dev

Example Usage

curl -XPOST http://localhost:3001/rpc -H 'Content-Type: application/json' -H 'Authorization: Bearer your-jwt-token' -d '{"jsonrpc":"2.0","method":"ping","params":[],"id":0}'

You should see: {"jsonrpc":"2.0","id":0,"result":"pong"}

API

POSTMAN Collection: api.postman_collection.json

REST Api:

  • [POST] path=/token | body={"username":"","password":""} Obtain jWT token for further calls

RPC Methods (/rpc):

  • method=ping | params=[] Is a RPC healthcheck method
  • method=list | params=[from, to, page, size] Retrieve list of items delivered or to be delivered
    • *from[date] - list from date, default now - 7 days
    • *to[date] - list to date, default now
    • *page[int] - list from page starting w/ 1, default 1
    • *size[int] - items per page, default 100
  • method=pay | params=[id] Pay for an order
    • !id[int] - Id of the order (orderID)

Pay method $.result is an HTML string that might be open in browser or webview to start the payment flow.

All RPC method should be authorized using JWT token obtained from /token endpoint.

All date types are passed as strings to new Date() constructor (@ref https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).

TODO

  • Add JWT tokens expiration and invalidation logic

pt.md-api's People

Contributors

alexanderc avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.