Skip to content

README.md

Latest commit

 

History

History
87 lines (62 loc) · 6.11 KB

README.md

File metadata and controls

87 lines (62 loc) · 6.11 KB

Note

Simply replace .com with .org to start using the updated AmiiboAPI

Amiibo RESTful API

Offical Site discod Check Database Generate game info Update json

A RESTful API that was created for retriving amiibo information.

Deploy Deploy

Features

  • Regularly updated
  • RESTful API
  • Universal compatibility

Usage

Full amiibo: https://amiiboapi.org/api/amiibo

Specific Amiibo (i.e. Mario): https://amiiboapi.org/api/amiibo?name=mario

When searching for amiibo, you can use the id or amiibo name. Key must be in hexdecimal example 0x1D0

More APIs examples can be found here: https://www.amiiboapi.org/docs/

Requirements (if you want to host)

Manually Setup (if you want to host)

  1. Install python
  2. Install the requirements using pip install -r requirements.txt
  3. Run app.py or launch via gunicorn app:app

SSL Certificate Setup (EC2 + Let's Encrypt / Certbot)

For EC2 deployments where the app runs directly from this project root (no /www directory), use:

chmod +x scripts/certbot_certificate.sh
./scripts/certbot_certificate.sh all

This script:

  • Registers/requests a certificate with certbot (amiiboapi.org,www.amiiboapi.org by default)
  • Copies fullchain.pem and privkey.pem from /etc/letsencrypt/live/amiiboapi.org/ into the project root
  • Sets file permissions to read/write for owner+group (660) on both certificate files
  • Installs /etc/cron.d/amiiboapi-certbot to run renewal checks monthly
  • certbot renew attempts renewal for certificates with 30 days or less remaining (90-day validity period)

Important

certbot --standalone needs port 80 available. Stop any process using port 80 before running issuance if needed.

If needed, set custom domains:

CERTBOT_DOMAINS="example.org,www.example.org" CERTBOT_PRIMARY_DOMAIN="example.org" ./scripts/certbot_certificate.sh all

Optional (recommended) email for Let's Encrypt expiration notices:

CERTBOT_EMAIL="admin@example.org" ./scripts/certbot_certificate.sh all

Heroku Setup (if you want to host)

Click on the Deploy to Heroku button and you are good to go! Heroku is a paid service and requires an account to use

Credit


AmiiboAPI Moe Counter!