NGCareerPro

API access is available on the Premium plan only.

Contact [email protected] to request API credentials and discuss your integration requirements.

Overview

The NGCareerPro API allows your institution to read graduate outcome data, student career readiness scores, and assessment results from your own systems — for integration with SIWES portals, academic management systems, or institutional dashboards.

The API is REST-based, returns JSON, and uses bearer token authentication. All requests must be made over HTTPS.

Base URL: https://api.ngcareerpro.com/v1

Authentication

All API requests require a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API keys are issued per institution and can be rotated from your admin dashboard (Premium accounts). Do not expose your API key in client-side code.

Endpoints

GET /students

Returns a paginated list of students with their career readiness scores.

GET /v1/students?page=1&limit=50&department=Computer+Science

Response:
{
  "success": true,
  "data": {
    "students": [
      {
        "id": "stu_abc123",
        "name": "Adaeze Uchenna",
        "matric": "100402034",
        "department": "Computer Science",
        "level": "400",
        "employabilityScore": 72,
        "careerGoal": "Software Engineering",
        "assessmentsCompleted": true
      }
    ],
    "total": 4831,
    "page": 1,
    "pages": 97
  }
}

GET /students/:id

Returns full career profile for a single student.

GET /outcomes

Returns graduate outcome data for reporting.

GET /v1/outcomes?year=2025

Response:
{
  "success": true,
  "data": {
    "graduationYear": 2025,
    "totalGraduates": 1240,
    "employed": 965,
    "furtherStudy": 142,
    "nysc": 1240,
    "employmentRate": 0.78,
    "byFaculty": { ... }
  }
}

GET /reports/accreditation

Returns a pre-formatted accreditation-ready outcome report as JSON or PDF (pass format=pdf).

POST /students/:id/outcomes

Submit a graduate outcome update (employment, NYSC, further study).

POST /v1/students/stu_abc123/outcomes
Content-Type: application/json

{
  "type": "employed",
  "employer": "Flutterwave",
  "location": "Lagos",
  "startDate": "2025-09-01"
}

Rate Limits

100 requests per minute per API key
10,000 requests per day per institution
Bulk export endpoints: 5 requests per hour

Errors

All errors return a consistent JSON structure:

{
  "success": false,
  "message": "Student not found",
  "code": "NOT_FOUND"
}

HTTP status codes follow standard conventions: 200 OK, 400 Bad Request, 401 Unauthorized, 404 Not Found, 429 Rate Limited, 500 Server Error.

Webhooks

Premium accounts can register a webhook URL to receive real-time events when students complete assessments, reach career milestones, or graduate. Contact [email protected] to configure webhooks.

SDKs & Integration Support

We do not currently publish official SDKs but the REST API is compatible with any HTTP client. Our team can assist with integration into common academic management systems and institutional ERPs. Contact [email protected] for integration support.

Contact

For API access or technical integration questions:
Email: [email protected]
WhatsApp: +2348133651766

API Documentation