Haruna

The ShipGirl Project; Haruna. (c) Kancolle for Haruna.

Why Haruna ?

Fast and reliable.

Run and forget, Haruna can run with 99.9% uptime.

Rest based API for your easy vote checks without opening a webserver on your bot.

Webhook based API is also available if you are someone who needs both the API and Realtime vote handling.

Documentation

Rest API

POST /newVote

The endpoint that is exposed to Top.gg (Discord Bot List); Refer to the image below.

GET /voteInfo

The endpoint which you can use to check for votes.

Headers:

{
  "authorization": "the authorization key you have set on Top.gg (Discord Bot List) webhook"
}

Query String: user_id

Returns: JSON string.

// User Voted
{
  "user": "23213512",
  "timestamp": 432483204, 
  "isWeekend": true,
  "timeLeft": 274013
}
// User Didn't Vote
{
  "user": false
}

GET /stats

Returns: Current status of server in JSON string.

Webhook API [1.4.0 and later]

If enabled, it will send a POST request containing the user who voted in the URL of your choice.

For checking the request validity, you can check the authorization header as it will send the same RestAuth you have set on your config

Returns: JSON string.

{
  "user": "389138132391230131031903",
  "isWeekend": true
}

Haruna's API Wrappers

Java

Javascript

C#

you can also create your own and PR if you want to contribute it.

How to Host

Manually

1. Download the latest haruna.jar from Github Releases. Click me

2. Download HarunaConfig.json from github. Click me

3. Configure HarunaConfig.json according to your liking and put it BESIDE haruna.jar

4. Start the server via java -jar haruna.jar

5. To verify Haruna is working, navigate to http://localhost:port_you_specified/ or http://your_server_ip:the_port_you_specified/. Example

Docker-Compose

1. Get docker-compose file. Click me

2. Update values according to your needs (ports and environment)

3. Start the server via docker-compose up -d

Haruna's config file example & explanation.

{
  "RestAuth": "weeb_handler", 
  "DBLAuth": "JRIrjrqwrpURJQWOPRj_rfnQEUi_KRqop",
  "Prefix": "/webserver",
  "Weebhook": "https://discordapp.com/api/webhooks/84293482482420424024802/sneaky_token_OWO",
  "PostWeebhook": "localhost:6969",
  "Debug": true,
  "Port": 1024,
  "Threads": 8,
  UserTimeout: 432000000
}

• RestAuth (REST_AUTH) is the Discord Bot List Webhook Authorization.
• DBLAuth (DBL_AUTH) is your token for Discord Bot List.
• Prefix (PREFIX) used if you want to reverse proxy. Leave it blank if you don't need to use it (Optional)
• Weebhook (WEEBHOOK) is your Discord Webhook link (Optional)
• PostWeebhook (POST_WEEBHOOK) is where Haruna will try to send a POST request of the user who voted Refer Here (Optional)
• Debug (DEBUG_ENABLED) is if you want to enable debug logs of Haruna (Optional, Default: false)
• Port (PORT) is what port you want this server hosted (Optional, Default: 1024)
• Threads (THREADS_COUNT) is how many threads you want this server to have (Optional, Default: Your CPU Thread Count)
• UserTimeout (USER_TIMEOUT) is how long the user will stay in database in ms (Optional, Default: 43200000)

Between parenthesis is the key to set as environment variable in case you want to use this configuration way.

Support

We provide support for usage of this API in our Official Server's #support channel which is in HERE

Made with ❤️ by Saya#0113