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

PHP 5.5 and later

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

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

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

• Account
• AccountAccountData
• AccountSettings
• AccountSettingsSendFax
• AccountSettingsSendFaxRetry
• Error
• Fax
• FaxCostDetails
• File
• MemberDetail
• Number
• NumberNotifications
• Outbox
• OutboxComment
• OutboxFileChanges
• OutboxFiles
• OutboxInitiatedFrom
• OutboxStatusChanges
• PayloadFaxModification
• PayloadNumberModification
• PayloadOutbox
• PayloadOutboxComment
• PayloadOutboxModification
• PayloadOutboxOptions
• PayloadOutboxOptionsRetry
• ResponseAccountList
• ResponseArchive
• ResponseArchiveData
• ResponseNumberList
• ResponseOutboxList

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
• Scopes:
• all: for now when a user grant permission, all grants will be permitted