Download the PHP package tippiti/api-client without Composer

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

Example code of tippiti/api-client

Informations about the package api-client

Tippiti PHP Client

Official PHP client for the Tippiti API – the transcription and dictation platform for physicians, attorneys, forensic examiners and professional typing services.

Framework-agnostic. Built on Guzzle and PSR-7 / PSR-18. Runs in Laravel, Symfony, Slim or plain PHP.

Installation

Requires PHP 8.1 or newer. Pulls Guzzle as its default HTTP client.

Quick start

Every endpoint, request body, parameter and response is typed, derived directly from the OpenAPI specification at apidocs.tippiti.io.

Authentication

Tippiti::configure() configures Bearer-token authentication against https://app.tippiti.io/api. Tokens are scoped to the issuing user's permissions (main user or sub-user with the relevant capabilities) and can be created in the account settings.

Resource IDs

All resource identifiers are sqid-encoded strings prefixed with aid-, for example aid-xyz12345. Model properties reflect this – IDs are typed string, never int:

Raw integer IDs are rejected with a 404 response.

Available Api classes

After installation, every API group has a dedicated class under Tippiti\Api\Generated\Api\*Api:

Method names follow the operationIds from the specification: dictationIndex, dictationStore, dictationShow, folderIndex, accountUpdate and so on. See apidocs.tippiti.io for the full operation list.

Response envelope

Successful responses expose getSuccess(): bool and getData(): mixed accessors. Failure responses throw Tippiti\Api\Generated\ApiException containing the HTTP status code, the decoded response body and the response headers. Validation failures produce ApiException with status 422 and per-field error messages. Rate-limit breaches produce ApiException with status 429 and a Retry-After header.

Custom base URL

Custom HTTP client

Pass your own Guzzle-compatible client to any Api constructor – useful for custom timeouts, proxies, HTTP/2 tuning, or middleware:

Versioning

This client follows Semantic Versioning. A release note in CHANGELOG.md accompanies every version. Breaking changes to the underlying API produce a major version bump of this package.

License

MIT. The Tippiti platform, trademarks and data are not covered by this license.

All versions of api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
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 tippiti/api-client contains the following files

Loading the files please wait ...