https://github.com/geolessel/pco-api-elixir
An Elixir package for consuming Planning Center Online's public API
https://github.com/geolessel/pco-api-elixir
api church elixir planningcenter
Last synced: about 1 year ago
JSON representation
An Elixir package for consuming Planning Center Online's public API
- Host: GitHub
- URL: https://github.com/geolessel/pco-api-elixir
- Owner: geolessel
- License: mit
- Created: 2016-05-13T19:44:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-12-19T17:44:07.000Z (over 6 years ago)
- Last Synced: 2025-04-11T14:10:31.412Z (about 1 year ago)
- Topics: api, church, elixir, planningcenter
- Language: Elixir
- Size: 401 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PcoApi
**TODO: Add description**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add pco_api to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:pco_api, "~> 0.1.0"}]
end
```
2. Ensure pco_api is started before your application:
```elixir
def application do
[applications: [:pco_api]]
end
```
## Usage
To get this working locally, `PcoApi` needs to know your API key/id
and secret. If you need to get one, go to
[https://api.planningcenteronline.com/oauth/applications](https://api.planningcenteronline.com/oauth/applications)
and set up a **Personal Access Token**.
Once you have an **Application ID** and **Secret**, you need to use
those in environment variables when you start your app. For
development, you can start up an `iex` session by `export`ing the
variables, or you can explicitly set them during startup:
```bash
> PCO_API_KEY="MY_KEY" PCO_API_SECRET="MY_SECRET" iex -S mix
```
You can then grab a list of people in your account with:
```elixir
iex(1)> PcoApi.People.get("people")
```