API users and links.
Senast ändrad: 20-08-2024Through an API key you can retrieve information (automatically) on the platform. There are several parties that have established links to systems such as Salesforce, Collectekracht, Microsoft Dynamics.
Content of article
API-key
You can generate and use an API key yourself at no cost. An API key allows you to make API calls and retrieve information from the database associated with the platform. An API key is linked to a site and so it only allows you to retrieve information about that site.
Limit
There is a default limit of 100 requests per minute and 500 requests per hour. This is also sufficient to retrieve the data. If you want to increase this number you can contact iRaiser.
Use API key
In our developer portal you can find all the technical information about using the API key. So you can see exactly what information you can retrieve. For example, there you can see the iRaiser API, the Digicollect API and the technical information about iRaiser Connect.
API key generation
Via Integrations > API users you will arrive at the overview page with API users. Here you can generate a new key as follows:
Click Add and enter the user's name there. You can then choose whether the user can only read information, or also modify it (via write permissions). In this Menu you can also deactivate the user at a later time.
When you click save, the API users have been created. Click on the i to see the key
You will also see information there about the known ip addresses this key has been used by and what calls have been made.
API key sharing
An API key basically gives you access to all data found on the site. Therefore, make sure you share a key in a secure way. For example, if an integrator needs it to establish the link, we recommend that you send it via a password-protected file and share the password by text message, for example.
Link with CRM
You can get data from the iRaiser platform into your own CRM in several ways. In this we offer a fixed form where you can get the data from the platform and then you have to process it yourself and get it into your CRM. Often there is still a conversion needed to make sure that the data is converted to the format of data in the CRM and needs to be linked properly. Therefore, to set up that process, an integrator is often used.
Based on downloads
From the iRaiser dashboard you can create downloads, for example of Fundraisers, Teams and Donations. There are customers of ours who periodically do an import into a CRM based on these downloads. Often there is still some editing to do to make the data suitable for import, or the import is aligned with the Excel file you can generate from iRaiser. We usually announce changes to the columns, to ensure that this does not disrupt the customer process.
Automatic linking (not real-time)
Using the api key, you can periodically retrieve data from the iRaiser platform. For example, if you retrieve the data once an hour or a day and process it in the CRM. Creating such a link does require technical knowledge and usually you need an integrator for this.
Coupling via iRaiser Connect (realtime)
You can also establish a real-time link via iRaiser Connect. This works on the basis of webhooks. We are given an endpoint to send a message to when a certain event occurs and based on that, you can use the api key to retrieve all the corresponding data and then process it yourself. We can optionally set at which events such a message is sent. Creating such a link does require technical knowledge and usually you need an integrator for this. Installing the link also involves costs on our side. If you want to know more about this, please contact your account manager.
Salesforce link (real-time via iRaiser objects)
You can interface with Salesforce based on iRaiser Connect. However, we have also established a standard link with Salesforce. The difference with the link via iRaiser Connect is that in Salesforce we put all the information in ready-made iRaiser objects (a kind of packages with all the data in it) directly into Salesforce. It then has to be retrieved by you and put into Salesforce. However, you do need technical knowledge to ensure that the data is then processed in Salesforce. For example, you need to see exactly what data you want and you may need to convert the data to another format so that it matches your data. To automate this, customers of ours often use an integrator. You can find the technical information on this page under the heading Salesforce. Installing the link on our side also involves costs. If you want to know more about this you can contact your account manager.
Famous integrators
CM
CM offers links to their CDP (Customer Data Platform) where all the information comes in. From here you can set up mails, but especially mobile journeys during events, for example. They can also link with Digicollect for during a collection. More information.
STB Eudonet
STB Eudonet has built a link to its CRM for both iRaiser and Digicollect. In real time, a Donations or Fundraisers is also immediately visible in Eudonet's CRM. More information.
Ifunds (Engage)
Via Ifunds, iRaiser can be paired with Engage 365. All campaigners, donors and donations and Newsletter subscriptions that are recruited automatically land in Engage 365. More information.
Cisis (Converse/Collective Force)
Cisis can link an iRaiser platform to Converse and Digicollect platforms link to Collectekracht. More information.
Xapti
Xapti offers an online CRM solution in which everything around the giving process can be recorded. Data from iRaiser can be linked to this. More information.
Civicoop (automatic link, not real-time)
Civicoop has linked to CiviCRM. CiviCRM is an open source CRM aimed at non-profits and CiviCooP has been active in the Dutch speaking CiviCRM world for quite a few years. In doing so, they are mostly in Flanders.
The extension that has been developed is open source and can therefore be used by more organizations that work with CiviCRM and would like to retrieve data from iRaiser. The existence can be found here.
Salesforce links (via our Salesforce link)
Xebia (formerly Gcompany)
Xebia as an integrator has already helped many customers establish Salesforce links and ensures that data from iRaiser is processed in your own Salesforce environment. More information.
Cobra
Cobra also works with the standard Salesforce link and helps streamline customer processes with Salesforce. More information.
Bluedesk
Bluedesk integrates data from the iRaiser platform into Salesforce via the iRaiser link. More information
Outbirds (formerly Bridgin.it)
Outbirds provides a customized link between the iRaiser platform and Salesforce. More information.
Customer examples
The api can also be used in other ways, such as during events. Here are some examples:
Maarten van der Weijden Foundation - streaming
The Maarten van der Weijden Foundation themselves linked to their stream via the api. In doing so, they periodically collected recent Donations and displayed them on the stream:
They also created a library for this purpose, which other customers (with technical knowledge) can also use. They did not use an iRaiser Connect link, but kept in mind any limits during data retrieval.
Dutch gaming marathon - streaming
The Dutch Gaming Marathon used iRaiser Connect in 2020 to show real-time Donations and related messages on the stream. You can read more about this in this article.
KNRM - Auction Site
Kikz has linked to the KNRM via the api. They have a special auction site where action starters can log in with their iRaiser account (this is checked via the api if the data is correct) and auction their own items. After the auction the amount is added to the right place in the iRaiser platform via a manual donation.
Erasmus MC Foundation - link to Eroutes
After starting an action for the Tour Against Cancer, action starters received an invitation from eRoutes. Based on your own chosen distance and your GPS location, the app suggests routes to run.