Download the PHP package elvanto/api-php without Composer
On this page you can find all versions of the php package elvanto/api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elvanto/api-php
More information about elvanto/api-php
Files in elvanto/api-php
Package api-php
Short Description API PHP Library for Elvanto church management software.
License MIT
Homepage https://github.com/elvanto/api-php/
FAQ
Example:
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 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.
Informations about the package api-php
Elvanto API PHP Library
This library is all set to go with version 1 of the Elvanto API.
Authenticating
The Elvanto API supports authentication using either OAuth 2 or an API key.
What is This For?
- Quick summary This is an API wrapper to use in conjunction with an Elvanto account. This wrapper can be used by developers to develop programs for their own churches, or to design integrations to share to other churches using OAuth authentication.
- Version 1.0
Using OAuth 2
This library provides functionality to help you obtain an Access Token and Refresh token. The first thing your application should do is redirect your user to the Elvanto authorization URL where they will have the opportunity to approve your application to access their Elvanto account. You can get this authorization URL by using the authorize_url() method, like so:
If your user approves your application, they will then be redirected to the redirect_uri you specified, which will include a code parameter, and optionally a state parameter in the query string. Your application should implement a handler which can exchange the code passed to it for an access token, using exchange_token() like so:
At this point you have an access token and refresh token for your user which you should store somewhere convenient so that your application can look up these values when your user wants to make future Elvanto API calls.
Once you have an access token and refresh token for your user, you can authenticate and make further API calls like so:
All OAuth tokens have an expiry time, and can be renewed with a corresponding refresh token. If your access token expires when attempting to make an API call, you will receive an error response, so your code should handle this. Here's an example of how you could do this:
Using an API key
To send parameters in your call add an array with your parameters after the endpoint.
For example, to edit an existing members email address:
Documentation
Documentation can be found on the Elvanto API website.
Updates
Follow our Twitter to keep up-to-date with changes in the API.
Support
For bugs with the API PHP Wrapper please use the Issue Tracker.
For suggestions on the API itself, please post in the forum or contact us via our website.
