Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Matheus Cesar C. - Matsukii committed Oct 3, 2019
1 parent 0964761 commit ea85240
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 17 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,45 +17,46 @@ A set of useful apis
* mysql


# usage
# General usage

## Og tag getter
https://open-toolkit-api-tolls.herokuapp.com/apis/ogtags?u=[URL]
https://open-toolkit-api-tolls.herokuapp.com/apis/ogtags?u=[URL]<br><br>

parameters:<br>
u: url<br>
response:<br>
* u: url<br>

response:<br>
* json

### see samples file or below


## SVG QR Code generator
https://open-toolkit-api-tolls.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]<br>
https://open-toolkit-api-tolls.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]<br><br>
parameters:<br>
u: data<br>
d: dark/light [true/false] (if true generates a lighet qr)<br>
w: width<br>
c: HEX color *without the #* _default colors: for dark themes=#CCCCCC and light=#222222_<br>
bg: background color in HEX *without the #* _default is transparent_
* u: data<br>
* d: dark/light [true/false] (if true generates a lighet qr)<br>
* w: width<br>
* c: HEX color **(without the #)** _default colors: for dark themes=#CCCCCC and light=#222222_<br>
* bg: background color in HEX **(without the #)** _default is transparent_
*if any param was send, a message will be showed*

response:<br>
* SVG document


## Video URL parser
http://opentk-apis.herokuapp.com/apis/vidurl?u=[URL]
http://opentk-apis.herokuapp.com/apis/vidurl?u=[URL]<br>
params:<br>
u: video url
* u: video url

response:<br>
* json

## Bad-word message filter
https://open-toolkit-api-tolls.herokuapp.com/apis/filter?msg=[message_to_filter]
https://open-toolkit-api-tolls.herokuapp.com/apis/filter?msg=[message_to_filter]<br><br>
params:<br>
msg: message
* msg: message

response:<br>
* json
Expand Down Expand Up @@ -92,9 +93,15 @@ response:<br>


# Modules credits

[qrcode-svg by papnkukn](https://github.com/papnkukn/qrcode-svg)<br>
[bad-words by web-mech](https://github.com/web-mech/badwords)<br>
[jsVideoUrlParser by Zod-](https://github.com/Zod-/jsVideoUrlParser)<br>
[openGraphScraper by jshemas](https://github.com/jshemas/openGraphScraper)<br>
[metafetch by brahma-dev](https://github.com/brahma-dev/metafetch)<br>


# LICENSE
* MIT



2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "opentk-apis",
"version": "1.0.3",
"version": "1.0.4",
"description": "a service to get open graph meta tags",
"main": "index.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion sample.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"ogtags" : {
"ogtags" : {
"name": "GitHub",
"title": "Build software better, together",
"desc": "description...",
Expand Down

0 comments on commit ea85240

Please sign in to comment.