The Collect REST API lets you create, manipulate and retrieve data related to your activities, collectors, members and transactions. It also gives you access to different types of statistics data. You can use the API to build your own services or integrate it with your existing systems or services. The API can be used as an alternative to, or in combination with, the existing Puzzel Collect web pages.
The API uses Auth0 for authentication and you will need to set up an account.
The Collect API supports the Open API Initiative and implements the Swagger 2.0 specification. You can access the swagger definitions as JSON here or as YAML here. There are many integration tools available that support this specification.
You check out the documentation for all the API operations here or read on for an overview.
| Term | Description |
|---|---|
| Service | The service ID identifies your account with the Puzzel platform. A service can have one or several activities. |
| Activity | An activity might be a SMS service for donations, a web donation form or a SMS service for recruiting, billing and communicating with a member network. |
| Donator | An end user donating money to an activity. |
| Collector | A collector is a person that collects money on your behalf. A collector can be part of one or more activities. |
| Member | A user joining an activity as a member. For example for recurring donations or starting a NGO membership |
Check out the swagger-ui documentation or import the swagger JSON or YAML definitions into an integration tool or directly into Postman.
The Activity Resource has several operations for manipulating activities.
The Collector resource has operations for manipulating collectors.
The Collector resource has operations for manipulating members.
The Transaction Resource gives access to transaction data.
The Statistics Resource has operations to access several types of statistics data for transactions and turnover (revenues).