Download the PHP package proximify/uniweb-api without Composer
On this page you can find all versions of the php package proximify/uniweb-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download proximify/uniweb-api
More information about proximify/uniweb-api
Files in proximify/uniweb-api
Package uniweb-api
Short Description Reference API client for the UNIWeb application.
License MIT
Informations about the package uniweb-api
UNIWeb API Client
Overview
The UNIWeb API allows institutions to seamlessly integrate UNIWeb with their existing systems. This repository provides both the API documentation and a reference PHP client implementation.
[!NOTE] All the examples are located in the
queries
folder.
Key Features
- Secure Access Control: Manage API access permissions at the institutional level
- Read/Write Operations: Full support for reading and updating institutional data
- JSON Format: Clean, well-structured JSON responses for easy integration
- Flexible Filtering: Query specific data subsets to optimize response times
- Reference Implementation: PHP client library with example use cases
Implementation Options
1. Simple Integration
Before implementing the API, consider if you just need to embed UNIWeb content. You can use the embed parameter:
2. Using Postman or Direct HTTP Requests
The simplest way to test and use the API is through direct HTTP requests. Here are some common examples:
3. Using the PHP Client
Begin by installing PHP Composer if you don't already have it.
Option 1: Create a New Project (Recommended for Testing)
Option 2: Add as a Dependency
Setup Guide
1. Get Your API Credentials
- Log into your UNIWeb instance
- Navigate to Administration → API section
- Click "Create a client"
- Enter a client name and save
- Click "View" on your new client to reveal the secret key
[!TIP] Review the Profile and CV data schemas located at Administration → Schemas
2. Configure Credentials
Create settings/credentials.json
:
⚠️ Security Note: Add settings/credentials.json
to your .gitignore
file
3. Run Example Queries
Using the Web Interface
- Navigate to the project directory
-
Start PHP's built-in server:
- Open
http://localhost:8000
in your browser - Select and run example queries through the web interface
Using the CLI
PHP Client Usage
Documentation
For detailed API documentation, see Complete UNIWeb API Documentation.
Sample Use Cases
The queries
folder contains example code for common API operations:
- Fetching user profiles
- Updating research activities
- Retrieving publication data
- And more...
Resource Paths
Resources are identified by paths following this structure:
Example paths:
profile/affiliations
cv/education/degrees
profile/membership_information
Content Types
members
: Individual user dataunits
: Organizational unit datagroups
: Group-related data
Common Operations
Reading Data
Send as GET or POST parameters.
Filtering Options
unit
: Filter by department/unittitle
: Filter by title (e.g., "Professor")loginName
: Filter by username/emailmodified_since
: Filter by modification dateonlyPublic
: Include/exclude private data
Language Support
Add language
parameter:
en
: English responsesfr
: French responses
Error Handling
Errors are returned in JSON format:
Common error codes:
- 98: OAuth token validation error
- 401: Unauthorized
- 403: Insufficient permissions
- 404: Resource not found
API Capabilities
The UNIWeb API provides:
- Secure authentication
- User data management
- Research activity tracking
- Publication management
- Institutional data access
- Custom data filtering
Support
For technical questions or issues:
- Check the API Documentation
- Create an issue in this repository
- Contact UNIWeb support through your institutional channels