Boost user conversions with AmiApi. Incentivise users with referral bonuses and rewards on signup.
These docs describe how to use the AmiApi API. We hope you enjoy these docs, and please don't hesitate to file an issue if you see anything missing.
Demo api running at: AmiApi
AmiApi is a JSON Rest-client with all routes namespaced under /api/v1
Open endpoints require no Authentication
Closed endpoints require a valid JWT token to be included in the header of the request with the format Authorization: Bearer <token>
. A JWT token can be acquired from the Login view above.
- Retrieve a user:
GET /api/v1/users/:id or GET /api/v1/users/:referral_code
- Show current logged in user's profile:
GET /api/v1/user/profile
git clone https://github.com/Dhul-Husni/amiapi.git
cd amiapi
ruby -v
The output should be ruby 2.7.2
If not, install the right ruby version using rbenv (it could take a while):
rbenv install 2.7.2
Using Bundler:
bundle install
cp config/database.yml.example config/database.yml
Remember to configure config/database.yml
by replacing the username
and password
to your local database user's credentials
rails db:create db:migrate db:seed
rails s