Giter Club home page Giter Club logo

permid-proxy's Introduction

permid-proxy

The very simple proxy for https://permid.org service

Installation

Run the command:

yarn install permid-proxy

Usage

PermID token

The service accepts only requests with the PermID token provided.

Here is how to get it:

  1. Go to https://permid.org website,
  2. Authorise there,
  3. Click API link in the top right corner,
  4. Click Display my API token

Store the token string securely and provide it to the permid-proxy app in PERMID_TOKEN process argument.

Running

Start the app with the command in the project root:

node node_modules\permid-proxy\index.js --PERMID_TOKEN <token> --PORT 2222 --HOST 127.0.0.1

where is the PermID API token you've got as described above.

Parameters

  • PERMID_TOKEN: Required. The service fails to start without it.
  • HOST: Optional. Default: localhost
  • PORT: Optional. Default: 1380.

Query

Query the service with the link: http://localhost:1380/api/permid/search?q=TRI where TRI is the search term.

Contributing

Feel free to extend, fix and improve the service.

License

The project is distributed under the GNU GENERAL PUBLIC LICENSE.

permid-proxy's People

Contributors

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