Download the PHP package jrbarnard/efapiwrap without Composer

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

Informations about the package efapiwrap

PHP API wrapper for the Events Force API

Build Status

An API client package for the Events Force API. For reference to what kind of data you can pass to the API methods refer to the general API documentation. To get a client slug / client account string see here

Contents

  1. Requirements
  2. Installation
  3. Initializing
  4. Full usage
    • Events
    • Attendees
    • Sessions
    • People
    • Invoices
    • Payments
  5. Responses
  6. Contributing
  7. Licence

Requirements

Installation

Initializing and basic usage of the client

Note: The follow examples all use the apiexample credentials as shown here

Now you are ready to use specific resources and methods The resources are split as shown on the api docs E.g to access events get all you would do the following:

The response is a \Psr\Http\Message\StreamInterface

Usage - Full method map

Events - http://docs.eventsforce.apiary.io/#reference/events

Get all - /events.json
Get single - /events/{event_id}.json

Attendees - http://docs.eventsforce.apiary.io/#reference/attendees

Get all attendees for an event - /events/{event_id}/attendees.json

Available parameters:

Get a single attendee for an event by their person ID - /events/{event_id}/attendees/{attendee_id}.json
Update an attendee - /events/{event_id}/attendees/{attendee_id}.json?_HttpMethod=PATCH

Needs testing with a full access api, not just the example

Authenticate an attendee - /events/{event_id}/attendees/authenticate.json

The value required for userID depends on the attendeeIDMode set for the event.

Sessions - http://docs.eventsforce.apiary.io/#reference/sessions

Get all sessions for an event - /events/{event_id}/sessions.json
Get a single session for an event - /events/{event_id}/sessions/{session_id}.json

People - http://docs.eventsforce.apiary.io/#reference/people

Get a single person - /people/{person_id}.json

Invoices - http://docs.eventsforce.apiary.io/#reference/invoices

Get all invoices - /invoices.json

Can have an optional invoiceNumberAfter parameter which will return the items with id's from that point, defaults to 0

Get a single invoice - /invoices/{invoice_number}.json
Update an invoice - /invoices/{invoice_number}.json?_HttpMethod=PATCH

Needs testing with a full access api, not just the example

Payments - http://docs.eventsforce.apiary.io/#reference/payments

Get all payments for an invoice - /invoices/{invoice_number}/payments.json
Post a payment against an invoice /invoices/{invoice_number}/payments.json

Needs testing with a full access api, not just the example

Get a single payment for an invoice - /invoices/{invoice_number}/payments/{payment_id}.json

Return values

The methods return a response object - http://guzzle3.readthedocs.org/http-client/response.html You can get the body of the response by calling:

You can also get the status code:

There are other helpers that can be seen here: http://guzzle3.readthedocs.org/http-client/response.html

Example JSON output:

Contributing

Found in CONTRIBUTING.md

Licence

Found in LICENSE file

All versions of efapiwrap with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.0
guzzlehttp/guzzle Version ^6.1
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 jrbarnard/efapiwrap contains the following files

Loading the files please wait ....