Skip to content

Getting Started

Welcome to the uniR API! This API enables developers to manage university data including students, programs, roles, and more. Whether you want to build integrations, automate workflows, or create custom applications, this documentation will guide you through the basics to get started quickly.

Before you begin, make sure you have:

  • An active uniR account with API access
  • Your API key or authentication token
  • Basic knowledge of REST APIs and JSON
  • A tool to make HTTP requests (e.g., curl, Postman, or your preferred HTTP client)

The uniR API uses tokens for authentication. Include your API key or JWT token in the x-api-key header for all requests.

header
x-api-key: YOUR_API_KEY

All API requests are made to the base URL: https://api.unir.systems/v1/

Test that everything works with a simple ping:

bash
curl -H "x-api-key": "YOUR_API_KEY" \
https://api.unir.systems/v1/ping

Response Overview

  • Success:
    If the API key is valid, the server responds with HTTP status 200 OK and the following JSON:

    200OK
    {
    "status": "ok"
    }
  • Error:

    • If the API key is missing, the server responds with HTTP status 401Unauthorized and a message indicating the API key is missing.
    • If the API key is invalid, the server responds with HTTP status 401Unauthorized and a message indicating the API key is invalid.
    401Unauthorized
    {
    "message": "string"
    }

After completing these basics, explore the Guides for practical tutorials or jump to the Endpoints Reference to learn about all available API operations in detail.