🚀 Check IGN API

Game Nickname Lookup - Deployment Guide

✅ Ready for Shared Hosting 📖 Complete Documentation âš ī¸ No Node.js Required

📋 System Requirements

✅ Required

  • PHP 7.4+
  • MySQL 5.7+ or MariaDB
  • cURL Extension
  • mysqli Extension
  • Shared Hosting (Standard)

❌ NOT Required

  • Node.js
  • npm
  • Docker
  • VPS/Dedicated Server
  • Command Line Access
✓ This works on any standard PHP hosting with MySQL!

🚀 Quick Start (5 Minutes)

  1. Upload Files - Via FTP, upload all files to public_html/
  2. Create Database - In cPanel/Plesk, create database "api_games"
  3. Import Schema - Import database.sql file via phpMyAdmin
  4. Configure - Rename .env.example to .env and add database credentials
  5. Verify - Open config_check.php in browser, then delete it

📁 File Upload Instructions

Using FTP (Recommended for Shared Hosting)

  1. Download FTP client: FileZilla (free) or WinSCP
  2. Connect with your hosting FTP credentials
  3. Navigate to public_html folder
  4. Drag & drop all files from check-ign-main folder
  5. Wait for upload to complete
💡 Tip: Get FTP credentials from your hosting control panel (cPanel, Plesk, etc.)

đŸ—„ī¸ Database Setup

Via phpMyAdmin (Easy Way)

  1. Log into your hosting control panel (cPanel)
  2. Open "phpMyAdmin"
  3. Click "New Database"
  4. Enter name: api_games
  5. Select newly created database
  6. Go to "Import" tab
  7. Choose database.sql file
  8. Click "Go" to import
✓ Database is now ready!

âš™ī¸ Configuration

Step 1: Rename the File

Rename: .env.example To: .env

Step 2: Edit .env File

Open .env in a text editor and enter your database credentials:

DB_HOST=localhost DB_USER=your_database_user DB_PASS=your_database_password DB_NAME=api_games
â„šī¸ Note: Get DB_USER and password from your hosting control panel

✅ Verification

Step 1: Run Health Check

  1. Open browser: https://yourdomain.com/config_check.php
  2. Check all items are ✓ (green)
  3. If any are ✗ (red), fix the issue first

Step 2: Delete config_check.php

âš ī¸ Important: Delete config_check.php via FTP after verification for security

Step 3: Test API

Send a test request:

POST https://yourdomain.com/api_example.php game=GROWTOPIA user_id=Mrshadnic other_id=

Expected response:

{ "response": true, "data": { "status": 200, "nickname": "Mrshadnic" } }

🎮 Supported Games (Sample)

Game Name Code User ID Example
Mobile Legends: Bang Bang MOBILE_LEGENDS 604210151 (+ Zone: 8425)
Free Fire FREEFIRE 116502997
Growtopia GROWTOPIA Mrshadnic
Genshin Impact GENSHIN_IMPACT 700001772

50+ games supported! See README.md for complete list.

🔒 Security Features

🆘 Common Issues

❌ "Database connection error"

Solution:

  • Check database credentials in .env are correct
  • Verify database "api_games" exists
  • Ensure database user has permissions
  • Confirm MySQL is running on hosting

❌ "Game not found"

Solution:

  • Check game code spelling (case-sensitive)
  • Refer to README.md for correct codes
  • Update ApiGames.php if new games needed

❌ 500 Internal Server Error

Solution:

  • Run config_check.php to identify issue
  • Verify PHP version is 7.4+
  • Ensure cURL extension is enabled
  • Check file permissions (644)

📚 Documentation Files

✨ Production Checklist

đŸŽ¯ Next Steps

  1. Read QUICKSTART.md or DEPLOYMENT.md
  2. Prepare your hosting environment
  3. Upload files via FTP
  4. Create and import database
  5. Configure .env file
  6. Verify setup with config_check.php
  7. Delete config_check.php
  8. Test API endpoints
  9. Go live!