ISP Cloud API Docs

Interactive documentation and testing environment

🚀 Getting Started

🔑 Authentication Required: All API endpoints require an API key in the X-API-Key header.
Base URLs:
• Staging: https://m-stg.ispdatabase.com/v1/api
• Production: https://m.ispdatabase.com/v1/api
📋 API Key Generation:
To obtain an API key, please follow these steps:
1. Log in to your school portal at https://m.ispdatabase.com using an Administrator account
2. Navigate to Settings → API Keys
3. Click the Plus (+) icon at the bottom of the page
4. Configure your API key settings and save
Note: Only administrators can generate API keys for security purposes.

1. Test Your API Key

GET /integrations/validate-key 
curl -X GET "https://m.ispdatabase.com/v1/api/integrations/validate-key" \
     -H "X-API-Key: your-api-key-here"

2. Rate Limiting

⚠️ Rate Limits: All endpoints are rate-limited. Check response headers for limits.
📊 View Rate Limits Table ▼
📱 On mobile: Swipe table horizontally to see all columns
Route Method Rate Limit
/integrations GET 1000 requests/hour
/integrations/validate-key GET 1000 requests/hour
/integrations/fields/students GET 1000 requests/hour
/integrations/students GET 500 requests/hour
/integrations/agents GET 500 requests/hour
/integrations/homestays GET 500 requests/hour
/integrations/students/id/{id} GET 2000 requests/hour
/integrations/students/email/{email} GET 2000 requests/hour
/integrations/agents/id/{id} GET 2000 requests/hour
/integrations/agents/email/{email} GET 2000 requests/hour
/integrations/homestays/id/{id} GET 2000 requests/hour
/integrations/homestays/email/{email} GET 2000 requests/hour
/integrations/students POST 100 requests/hour
/integrations/students/{id} PUT 100 requests/hour
/integrations/agents POST 100 requests/hour
/integrations/agents/{id} PUT 100 requests/hour
/integrations/homestays POST 100 requests/hour
/integrations/homestays/{id} PUT 100 requests/hour
🎨 Color Legend:
• Green - Search endpoints (list operations)
• Yellow - Record endpoints (individual items)
• Red - Write endpoints (create/update operations)
• White - General API endpoints

📋 Available Endpoints

Students Management

GET /integrations/students - List students with filtering and pagination
GET /integrations/students/id/{id} - Get student by ID
GET /integrations/students/email/{email} - Get student by email
POST /integrations/students - Create new student
PUT /integrations/students/{id} - Update student

Agents Management

GET /integrations/agents - List agents
GET /integrations/agents/id/{id} - Get agent by ID
GET /integrations/agents/email/{email} - Get agent by email
POST /integrations/agents - Create new agent
PUT /integrations/agents/{id} - Update agent

Homestays Management

GET /integrations/homestays - List homestays
GET /integrations/homestays/id/{id} - Get homestay by ID
GET /integrations/homestays/email/{email} - Get homestay by email
POST /integrations/homestays - Create new homestay
PUT /integrations/homestays/{id} - Update homestay

🔧 Quick Examples

Create a Student

curl -X POST "https://m.ispdatabase.com/v1/api/integrations/students" \
     -H "X-API-Key: your-api-key-here" \
     -H "Content-Type: application/json" \
     -d '{
       "firstName": "John",
       "lastName": "Doe",
       "email": "john.doe@example.com",
       "phoneNumber": "+1234567890",
       "birthDate": "1995-05-15",
       "citizenship": "USA"
     }'

Search Students

curl -X GET "https://m.ispdatabase.com/v1/api/integrations/students?search=john&page=1&limit=10" \
     -H "X-API-Key: your-api-key-here"

📞 Support

Need Help?
• Email: support@ispdatabase.com
• Use the Interactive Docs tab for detailed endpoint information and testing