/faxplus-php

PHP SDK to use FAX.PLUS API

Primary LanguagePHPMIT LicenseMIT

FAX.PLUS PHP SDK

This is the FAX.PLUS API v1 developed for third party developers and organizations. In order to have a better coding experience with this API, let's quickly go through some points:

  • This API assumes /accounts as an entry point with the base url of https://restapi.fax.plus/v1.
  • This API treats all date and times sent to it in requests as UTC. Also, all dates and times returned in responses are in UTC
  • Once you have an access_token, you can easily send a request to the resource server with the base url of https://restapi.fax.plus/v1 to access your permitted resources. As an example to get the user's profile info you would send a request to https://restapi.fax.plus/v1/accounts/self when Authorization header is set to "Bearer YOUR_ACCESS_TOKEN" and custom header of x-fax-clientid is set to YOUR_CLIENT_ID

Requirements

PHP 5.5 and later

Installation & Usage

Composer

You can simply run composer require faxplus/faxplus-api to add faxplus-api to your composer.json and install it (faxplus-api is published to packagist).

Alternatively, to install the bindings via Composer, add the following to composer.json or your local composer config:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/alohi/faxplus-php.git"
    }
  ],
  "require": {
    "faxplus/faxplus-api": "*@dev"
  }
}

Then run composer install

Getting Started

There's a sample application which is intended to get you started using this SDK. Follow sample app instructions to run your first app.

Documentation for API Endpoints

All URIs are relative to https://restapi.fax.plus/v1

Class Method HTTP request Description
AccountsApi getAccounts GET /accounts Get account information of all members of your corporate account
AccountsApi getMemberDetails GET /accounts/self/member-details/{member_id} Get member details
AccountsApi getUser GET /accounts/{user_id} Get account information for admin or member
AccountsApi updateMemberDetails PUT /accounts/self/member-details/{member_id} Modify member details
AccountsApi updateUser PUT /accounts/self Modify account information
ArchivesApi deleteFax DELETE /accounts/self/archives/{fax_id} Delete a fax
ArchivesApi getFax GET /accounts/self/archives/{fax_id} Get a fax record
ArchivesApi listFaxes GET /accounts/{user_id}/archives Get fax records
ArchivesApi updateFax PUT /accounts/self/archives/{fax_id} Modify fax record
FilesApi getFile GET /accounts/self/files/{fax_id} get a file
FilesApi uploadFile POST /accounts/self/files upload a file
NumbersApi getNumber GET /accounts/self/numbers/{number} Get number information
NumbersApi listNumbers GET /accounts/self/numbers Get your numbers
NumbersApi revokeNumber DELETE /accounts/self/numbers/{number} Revoke number
NumbersApi updateNumber PUT /accounts/self/numbers/{number} Assign number
OutboxApi deleteOutboxFax DELETE /accounts/self/outbox/{outbox_fax_id} Delete a fax from outbox
OutboxApi getOutboxFax GET /accounts/self/outbox/{outbox_fax_id} Get an outbox record
OutboxApi listOutboxFaxes GET /accounts/self/outbox Get outbox records
OutboxApi sendFax POST /accounts/self/outbox Send a fax
OutboxApi updateOutboxFax PUT /accounts/self/outbox/{outbox_fax_id} Modify a fax record in outbox

Documentation For Models

Documentation For Authorization

fax_oauth