Download the PHP package scanii/scanii-php without Composer

On this page you can find all versions of the php package scanii/scanii-php. 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 scanii-php

scanii-php

Official PHP SDK for the Scanii content processing API.

SDK Principles

  1. Light. Zero runtime dependencies, stdlib only.
  2. Up to date. Always current with the latest Scanii API.
  3. Integration-only. Wraps the REST API — retries, concurrency, and batching are the caller's responsibility.

The only stdlib extensions required are ext-curl and ext-json, both shipped by default with every official PHP distribution (including the Windows builds).

Install

Requires PHP 8.4 or newer.

Quickstart

ScaniiClient::create returns a thread-friendly client that you can reuse across requests; the constructor performs no I/O.

Scanning from a stream

Pass any PHP stream resource — fopen(), tmpfile(), php://temp, etc.:

API

Method REST Returns
process($path, $metadata, $callback) POST /files ScaniiProcessingResult
processStream($stream, $filename, $contentType, $metadata, $callback) POST /files ScaniiProcessingResult
processAsync($path, $metadata, $callback) POST /files/async ScaniiPendingResult
processAsyncStream($stream, $filename, $contentType, $metadata, $callback) POST /files/async ScaniiPendingResult
processFromUrl($location, $callback, $metadata) POST /files ScaniiProcessingResult (v2.2 preview)
fetch($location, $metadata, $callback) POST /files/fetch ScaniiPendingResult
retrieve($id) GET /files/{id} ScaniiProcessingResult
retrieveTrace($id) GET /files/{id}/trace ?ScaniiTraceResult (v2.2 preview)
ping() GET /ping bool
createAuthToken($timeoutSeconds) POST /auth/tokens ScaniiAuthToken
retrieveAuthToken($id) GET /auth/tokens/{id} ScaniiAuthToken
deleteAuthToken($id) DELETE /auth/tokens/{id} void
retrieveAccountInfo() GET /account.json ScaniiAccountInfo

Full API reference: https://scanii.github.io/openapi/v22/.

Regional endpoints

Constant Endpoint
ScaniiTarget::US1 https://api-us1.scanii.com
ScaniiTarget::EU1 https://api-eu1.scanii.com
ScaniiTarget::EU2 https://api-eu2.scanii.com
ScaniiTarget::AP1 https://api-ap1.scanii.com
ScaniiTarget::AP2 https://api-ap2.scanii.com
ScaniiTarget::CA1 https://api-ca1.scanii.com
ScaniiTarget::AUTO https://api.scanii.comdeprecated, does not guarantee regional data placement

Pass any string URL for a custom or local endpoint:

Local development with scanii-cli

Run the integration tests against a local mock server — no real credentials needed:

Test credentials: key key, secret secret, endpoint http://localhost:4000.

Migration from uvasoftware/scanii-php

The PHP namespace is unchanged (Scanii\…). Other notable changes:

The old composer coordinate uvasoftware/scanii-php is deprecated and will not receive further updates.

API documentation

See https://scanii.github.io/openapi/v22/ for the full Scanii API contract.

License

Apache 2.0 — see LICENSE.


All versions of scanii-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
ext-curl Version *
ext-json Version *
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 scanii/scanii-php contains the following files

Loading the files please wait ...