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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

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

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

  1. Log into your UNIWeb instance
  2. Navigate to Administration → API section
  3. Click "Create a client"
  4. Enter a client name and save
  5. 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

  1. Navigate to the project directory
  2. Start PHP's built-in server:

  3. Open http://localhost:8000 in your browser
  4. 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:

Resource Paths

Resources are identified by paths following this structure:

Example paths:

Content Types

Common Operations

Reading Data

Send as GET or POST parameters.

Filtering Options

Language Support

Add language parameter:

Error Handling

Errors are returned in JSON format:

Common error codes:

API Capabilities

The UNIWeb API provides:

Support

For technical questions or issues:

  1. Check the API Documentation
  2. Create an issue in this repository
  3. Contact UNIWeb support through your institutional channels

All versions of uniweb-api with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1.0
proximify/cli-actions Version ^1.0.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package proximify/uniweb-api contains the following files

Loading the files please wait ....