Giter VIP home page Giter VIP logo

eltrade-cc300-driver's Introduction

Eltrade CC300 DRIVER API

v0.1.3

Ce Driver permet de communiquer en http avec le module electronique de controle de facturation de la DGI

SETUP

Le Driver est un mini serveur http. Il reçoit les commandes par http et les éxécutent sur l'équipement connecté puis, fournis le resultat en response de la requête HTTP.

Spécifications du serveur

  • Protocole : HTTP
  • Data Format : JSON
  • Authentification: Host Headers [NOT YET IMPLEMENTED]
  • ENDPOINT : http://localhost:38917

Pour utiliser cette API il faut :

  • Installer le driver
  • Envoyer des requetes HTTP/REST sur l'adresse de l'API
  • Traiter les reponses

USAGE

L'API fournit trois (03) commandes :

1 - [CHECK] : Elle permet de vérifier si le périphérique est connecté à l'ordinateur client
Path: /check
Method: GET
Body: N/A
Response:
  -  Quand l'équipement n'est pas connecté!
        code Http : 503
        corps de la réponse :  
            {"status": "DeviceNotConnected"} 
            
  -  Quand l'équipement  est bien  connecté!
        code Http : 200
        corps de la réponse :  
            {  "status": "Ready" } 
2 - [INFO] : Elle permet d'avoir des informations sur l'équipement et sur le contribuable :

NB: Cette requête prends 4s pour s'exécuter

Path: /info
Body: N/A
Method: GET
Response:
  -  Quand l'équipement n'est pas connecté!
        code Http : 503
        corps de la réponse :  
            {"status": "DeviceNotConnected"} 
            
  - Quand l'équipement est  connecté!
        code Http : 200
        corps de la réponse :  
            {
                "NIM": "ED04000623",
                "IFU": "3201910768821",
                "TIME": "2020-05-03 13:24:18 +0100 WAT",
                "COUNTER": "45",
                "SellBillCounter": "40",
                "SettlementBillCounter": "0",
                "TaxA": "0.00",
                "TaxB": "18.00",
                "TaxC": "0.00",
                "TaxD": "18.00",
                "CompanyName": "BFT",
                "CompanyLocationAddress": "RUE 12.170 12 IEME ARRONDISSEMENT",
                "CompanyLocationCity": "COTONOU",
                "CompanyContactPhone": "61006060",
                "CompanyContactEmail": "[email protected]",
                "LastConnectionToServer": "2020-05-03 13:23:31 +0100 WAT",
                "DocumentOnDeviceCount": "45",
                "UploadedDocumentCount": "45"
            }
3 - [BILL] : Elle permet de créer une facture :

Pour créer une facture vous devez respecter le schéma json d'un de l'objet Bill (voir bill.spec.json)

NB: Utilisez le fichier bill.spec.json avec un validateur comme https://www.jsonschemavalidator.net/ par example pour valider votre json

Path: /bill
Body: 
    {
        "seller_id": "ABCDEFGHIJKLMN",
        "seller_name": "ABCDEFGHIJK",
        "payments": [{
                "mode": "V",
                "amount": 129.5
            }],
        "products": [{
            "label": "ABCD",
            "tax": "B",
            "price": 807.75,
            "bar_code": "ABCDEFG",
            "items": 723.75,
            "specific_tax": 504.5,
            "specific_tax_desc": "ABCDEFGHI",
            "original_price": 80.75,
            "price_change_explanation": "ABCDEFGHIJKLMN"
        }],
        "rt": "FA",
        "rn": "ABCDEFGHIJKLMNOPQRST",
        "buyer_ifu": "ABCDEF",
        "buyer_name": "ABCDEFGHIJKLMNOPQRSTUV",
        "aib": "N/A"
    }
Method: POST
Response:
  -  Quand l'équipement n'est pas connecté!
        code Http : 503
        corps de la réponse :  
            {"status": "DeviceNotConnected"} 
 -  Quand l'équipement est pas connecté et que tous s'est bien passé 
        code Http : 200
        corps de la réponse :  
            {"qr_code":"F;ED04000623;NW34NID6ZHANFNMZ2IU7LL3H;3201910768821;20200503135002"}

eltrade-cc300-driver's People

Contributors

issotina avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  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.