Giter VIP home page Giter VIP logo

telegram-reputation-service's Introduction

Telegram Reputation Service

Overview

Simple RESTful API for checking Telegram users reputation.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
npm run start:prod

Configuration

You can configure the application through environment variables.

Name Description Default value
ADMIN_API_KEY Used for creating and removing API Keys None (required)
PORT Port where the API is listening for connections 3000
DB_HOST Postgres host db
DB_PORT Postgres port 5432
DB_NAME Postgres database name tgreputation
DB_USER Postgres username postgres
DB_PASSWORD Postgres password postgres

Methods

GET /users/{userId}

Check user reputation. userId should be the Telegram userId.

GET /users/123456
{
  "id": "123456",
  "tags": [
    {
      "tag": "spam",
      "count": 3
    },
    {
      "tag": "flood",
      "count": 5
    },
    {
      "tag": "bot",
      "count": 7
    }
  ]
}

POST /votes

Submit a vote for a user. Requires an API Key.

Example using the API Key 1a2b3c4d.

POST /votes
Authorization: bearer 1a2b3c4d
{
  "userId": "123456",
  "tag": "spam"
}

POST /api-keys

Creates a new API Key. This method requires the ADMIN_API_KEY. Returns the created API Key.

POST /api-keys
Authorization: <ADMIN_API_KEY>

GET /api-keys

Returns all the created API Key. This method requires the ADMIN_API_KEY.

GET /api-keys
Authorization: <ADMIN_API_KEY>

DELETE /api-keys

Deletes all the created API Key. This method requires the ADMIN_API_KEY.

DELETE /api-keys
Authorization: <ADMIN_API_KEY>

telegram-reputation-service's People

Contributors

bigomby avatar

Stargazers

Felipe avatar

Watchers

James Cloos 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.