Download the PHP package sendwithus/api without Composer

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

Example code of sendwithus/api

Informations about the package api

sendwithus_php

Sendwithus PHP Client

Status

Build Status

Requirements

curl library must be installed and enabled in php.ini

Install it via Composer

Add it to your composer.json

Then install it with

composer install

Getting started

Emails

Get emails

Get specific template

Create emails

Create new email

We validate all HTML content

Create new email template version

We validate all HTML content

Update email version

We validate all HTML content

Send emails

NOTE - If a customer does not exist by the specified email (recipient address), the send call will create a customer.

Send Examples

Send request with REQUIRED parameters only

Send request with REQUIRED and OPTIONAL parameters

Send an email with multiple CC/BCC recipients

Send an email with a dynamic tag

Send specific version of an email

Send email with an inline image attachment

Send email with an inline encoded image attachment

Send email with attachments

Render templates

Example:

Get a Specific Email's Log

Example

Response

Resend a Specific Email from Log

Example

Response

Drip Unsubscribe

Drip Unsubscribe Example

Drips 2.0

List Drip Campaigns

List all drip campaigns for the current profile

Example

Response

Start on Drip Campaign

Starts a customer on the first step of a specified drip campaign

Example

Response

Remove from Drip Campaign

Deactivates all pending emails for a customer on a specified drip campaign

Example

Response

List Drip Campaign Details

Show all the steps and other information in a specified campaign

Example

Response

Customers API

Create Customer

Example

Update Customer

Example

Delete Customer

Example

List Customer Logs

List all customer logs

Example

Batch API

Batch requests together to be run all at once.

Usage

Create a batch_api object by calling start_batch().

Do any request you would do normally with the API but on the batch_api object.

Execute all commands at once by calling execute() on the object.

Example

Canceling Batch Request

Sometimes it is necessary to cancel all the api requests that have been batched, but not yet sent. To do that, use cancel():

Example

Once you have canceled a batch, you can continue to use the batch to make more requests.

Tests

Running Unit Tests

Make sure to have phpunit installed (http://phpunit.de/) and run the following from the root directory

Troubleshooting

General Troubleshooting

Enable Debug Mode

Debug mode prints out the underlying cURL information as well as the data payload that gets sent to Sendwithus. You will most likely find this information in your logs. To enable it, simply put "DEBUG" => true in the optional parameters when instantiating the API object. Use the debug mode to compare the data payload getting sent to sendwithus' API docs.

Response Ranges

Sendwithus' API typically sends responses back in these ranges:

If you're receiving an error in the 400 response range follow these steps:

Note: Enable Debug mode to check the response code.

All versions of api with dependencies

PHP Build Version
Package Version
No informations.
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 sendwithus/api contains the following files

Loading the files please wait ....