Skip to content

USAGE.md

Latest commit

 

History

History
183 lines (157 loc) · 5.47 KB

USAGE.md

File metadata and controls

183 lines (157 loc) · 5.47 KB

Usage

Attention: we should replace localhost with Ip or domain of your service

Adding notification entry

api v0

Send by method POST to http://localhost:8010/v0/jsonrpc with hash (unique entry hash) and data (base64 encoded URL) parameters

curl 'http://localhost:8010/v0/jsonrpc' -X POST -H 'Content-Type: application/x-www-form-urlencoded' --data-raw 'hash=0a0b0c0d&data=aHR0cDovLzEyNy4wLjAuMTo4MTgxL3JlcXVlc3Q='

api v1 (beta)

JSON-RPC request to http://localhost:8010/v1/jsonrpc

Minimalistic example

curl --header "Content-Type: application/json" --request POST \
  --data '{"jsonrpc": "2.0","id":1,"method":"add", "params": {"hash":"0a0b0c0d", "url":"http://127.0.0.1:8181/request"}}' \
  http://localhost:8010/v1/jsonrpc

Advanced example

curl --header "Content-Type: application/json" --request POST \
  --data '{"jsonrpc":"2.0","id":1,"method":"add","params": {"hash":"0a0b0c0d", "method":"POST", "url":"http://127.0.0.1:8181/request", auth={"user":"user1", "pass":"password"}}}' \
  http://localhost:8010/v1/jsonrpc

Decoding json object parameters API v1

Name Description
hash unique hash of the entry
method http methods: POST, PUT, JSONRPC, GET. default POST
url url address: https://domain/request
auth Authorization object. default null, Basic authorization: {"user":"user1", "pass":"password"}, Bearer token: {"bearer":"secret-token"}

You can get all parameters by API

Protecting the recipient page

Allowing access through robots.txt

Add an entry to the robots.txt file entry where FtPro-Notify-Bot is a parameter from the config.yml config or via api.

User-agent: FtPro-Notify-Bot
Allow: /

Security code for the page

You need to add the <meta name="ftpro-notify-verification" content="..."> entry inside the head tag on the page

<head>
...
  <meta name="ftpro-notify-verification" content="69aad49845d88aee43e5b696a5b249abb91a69b18dee85eaf5c76d31970b04fc">
</head>

Getting code via API

Post a request to address http://localhost:8010/v0/approve-code with the url parameter equal to the computed URL

curl -X POST "http://localhost:8010/v0/approve-code" -F "url=https://testn1.free-ton.online/test_push.php"

You will get a JSON object

{
  "result": {
    "metaName": "ftpro-notify-verification",
    "success": true,
    "robotsTxt": "FtPro-Notify-Bot",
    "metaUrl": "69aad49845d88aee43e5b696a5b249abb91a69b18dee85eaf5c76d31970b04fc",
    "metaMain": "69e9029faf0644ed77a6ea92e9195764b1c662d642b4861b221ebffb102d506d"
  },
  "id": "1",
  "jsonrpc": "2.0"
}
Name Description
metaName parameter name for meta tag
metaUrl parameter content for the page meta tag
metaMain parameter content for the main page meta tag

*metaMain for Main URL including /

Offline code computation

SHA 256 string

Pages: Web {URL} Notify, main page: Web {Main URL including /} Notify

Examples

echo -n Webhttps://testn1.free-ton.online/test_push.phpNotify | sha256sum
echo -n Webhttps://testn1.free-ton.online/Notify | sha256sum

Parameter structure

Required to create a notification entity via the API. Available at http://localhost:8010/v0/structure, but only practical in v1 http://localhost:8010/v1/structure

{
  "result": {
    "library": {
      "types": ["string", "int", "list", "object"],
      "list": {
        "method": ["GET", "PUT", "POST", "JSONRPC"]
      }
    },
    "success": true,
    "list": [
      {
        "descr": "Unique hash of the event ",
        "name": "hash",
        "type": "string",
        "required": true
      },
      {
        "descr": "url address",
        "name": "url",
        "type": "string",
        "required": true
      },
      {
        "descr": "List of available http methods",
        "default": "POST",
        "name": "method",
        "type": "list",
        "required": false
      },
      {
        "descr": "Parameter name",
        "default": "param",
        "name": "query",
        "type": "list",
        "required": false
      },
      {
        "descr": "Authorization object",
        "name": "auth",
        "type": "object",
        "required": false
      }
    ]
  },
  "id": "1",
  "jsonrpc": "2.0"
}

This API can be used to automatically generate a user interface form. For example, you can get a list of options for the method parameter at library.list.method

Service Information

http://localhost:8010/v0/info

{
  "result": {
    "success": true,
    "info": {
      "descr": "service description",
      "logo": "https://service.domain/logo.svg",
      "title": "Service name",
      "support_surf": "0:a9ef47b6bec35e001d1f295b34b9ec9abc0ca5c8623de4f414b4fd0b0dc6ca08"
    }
  },
  "id": "1",
  "jsonrpc": "2.0"
}