Difference between revisions of "Why use an API"

From Charitylog Manual
Jump to: navigation, search
Line 1: Line 1:
 
[[API Details|Go to API overview]]
 
[[API Details|Go to API overview]]
 +
 
The are 2 main reasons for using an API:
 
The are 2 main reasons for using an API:
 +
 
1) Where you need to access your data in another application. This might be for data analysis, or syncing records where there is some overlap, e.g. if some of your clients in Charitylog/Crossdata are also donors in your donor management system.
 
1) Where you need to access your data in another application. This might be for data analysis, or syncing records where there is some overlap, e.g. if some of your clients in Charitylog/Crossdata are also donors in your donor management system.
 
2) Where you want more freedom in the way your data is presented. Typically this is where you have complex reporting requirements that go beyond what can do done using the many reports in Charitylog/Crossdata.
 
2) Where you want more freedom in the way your data is presented. Typically this is where you have complex reporting requirements that go beyond what can do done using the many reports in Charitylog/Crossdata.
 +
 +
A question we often get asked is "Can I access the underlying database directly, using something like an OBDC Connector?". We do not allow this, for several reasons:
 +
 +
1)

Revision as of 10:59, 10 June 2020

Go to API overview

The are 2 main reasons for using an API:

1) Where you need to access your data in another application. This might be for data analysis, or syncing records where there is some overlap, e.g. if some of your clients in Charitylog/Crossdata are also donors in your donor management system. 2) Where you want more freedom in the way your data is presented. Typically this is where you have complex reporting requirements that go beyond what can do done using the many reports in Charitylog/Crossdata.

A question we often get asked is "Can I access the underlying database directly, using something like an OBDC Connector?". We do not allow this, for several reasons:

1)