Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Thu, 01 Sep 2022 19:32:34 GMT

Current revision posted to Frequently Asked Questions by Troy Wolbrink on 9/1/2022 7:32:34 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: API, Developers

The DonorHub API Approach (preferred)
If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach (obsolete)

DonorHub provides a SOAP/XML end point that other web applications can use to programmatically query donation data. The Staff Portal which is included with DonorHub gets all of its data exclusively through this web service. If you can see something on the Staff Portal, you can programmatically retrieve the same donation information .

Here's a demo of the Staff Portal:
https://test-staff.mytntware.com

Here are the SOAP web service endpoints where the demo Staff Portal gets its data:
https://test-api.mytntware.com/dataqueryservice.asmx

The Staff Portal works with the instance's single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request this info. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, they authenticate via the authentication provider and gets a service ticket. It passes in the service name and service ticket to the SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserNameDonorHub, and UserIsRegisteredwe offer a developer API. You need to persists the SessionID as this This is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via explained in the SOAP/XML api), Developers Group at: DonorHub requires you to maintain a list of "URL Prefixes". Contact TntWare to let us know what the URL is of your web application. We'll need the left most significant part of the URL (enough to make it "trusted") and add it to the list of trusted prefixes.API Documentation

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Sat, 01 Jun 2019 20:09:39 GMT

Revision 24 posted to Frequently Asked Questions by Troy Wolbrink on 6/1/2019 8:09:39 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web ServiceDevelopers

The DonorHub API Approach (preferred)

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach (obsolete)

DonorHub provides a SOAP/XML end point that other web applications can use to query donation data. The Staff Portal which is included with DonorHub gets all of its data exclusively through this web service. If you can see something on the Staff Portal, you can programmatically retrieve the same information.

Here's a demo of the Staff Portal:
https://test-staff.mytntware.com

Here are the SOAP web service endpoints where the demo Staff Portal gets its data:
https://test-api.mytntware.com/dataqueryservice.asmx

The Staff Portal works with the instance's single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request this info. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, they authenticate via the authentication provider and gets a service ticket. It passes in the service name and service ticket to the SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub requires you to maintain a list of "URL Prefixes". Contact TntWare to let us know what the URL is of your web application. We'll need the left most significant part of the URL (enough to make it "trusted") and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Sat, 01 Jun 2019 20:03:16 GMT

Revision 23 posted to Frequently Asked Questions by Troy Wolbrink on 6/1/2019 8:03:16 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach (preferred)

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach (obsolete)

Here's a demo of the Staff Portal:
https://test-staff.mytntware.com

Here are the SOAP web service endpoints where the demo Staff Portal gets its data:
https://test-api.mytntware.com/dataqueryservice.asmx

The Staff Portal works with the instance's single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request this info. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, they authenticate via the authentication provider and gets a service ticket. It passes in the service name and service ticket to the SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Sat, 01 Jun 2019 20:03:05 GMT

Revision 22 posted to Frequently Asked Questions by Troy Wolbrink on 6/1/2019 8:03:05 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach (preferred)

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx
https://test-staff.mytntware.com

Here are demos of the SOAP web service endpoints where the demo Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.asmx

You'll notice that the "dataquery" folder is next to the "staffportal" folder. If you have a Staff Portal, url, replace "staffportal/*" in your url with "dataquery/dataqueryservice2.asmx" and you'll have your own SOAP endpoint.
https://test-api.mytntware.com/dataqueryservice.asmx

The Staff Portal works with a the instance's single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request this info. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, it authenticates they authenticate via the authentication provider and gets a service ticket. It passes in the service name and service ticket to the SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Sat, 01 Jun 2019 20:00:40 GMT

Revision 21 posted to Frequently Asked Questions by Troy Wolbrink on 6/1/2019 8:00:40 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach (preferred)

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.asmx

The Staff Portal works with a single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, it authenticates via the authentication provider and gets a service ticket. It passes in the service name and service ticket to the SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link Contact TntWare to "(view log)". When you're first getting started let us know what the "view log" option URL is handy as you can see exactly what's being attempted (but not "accepted"). If you see of your portal in the log, copy web application. We'll need the left most significant part of the URL (enough to make it "trusted" "trusted") and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Fri, 05 Jan 2018 18:50:05 GMT

Revision 20 posted to Frequently Asked Questions by Troy Wolbrink on 1/5/2018 6:50:05 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.a
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.asmx smx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Fri, 05 Jan 2018 18:49:25 GMT

Revision 19 posted to Frequently Asked Questions by Troy Wolbrink on 1/5/2018 6:49:25 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.a https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.asmx smx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Fri, 05 Jan 2018 18:48:55 GMT

Revision 18 posted to Frequently Asked Questions by Troy Wolbrink on 1/5/2018 6:48:55 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice3.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Mon, 18 Sep 2017 20:11:16 GMT

Revision 17 posted to Frequently Asked Questions by Troy Wolbrink on 9/18/2017 8:11:16 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Mon, 18 Sep 2017 20:10:50 GMT

Revision 16 posted to Frequently Asked Questions by Troy Wolbrink on 9/18/2017 8:10:50 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more:

Read , read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Mon, 18 Sep 2017 20:04:57 GMT

Revision 15 posted to Frequently Asked Questions by Troy Wolbrink on 9/18/2017 8:04:57 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go. To learn more:

Read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Mon, 18 Sep 2017 20:04:41 GMT

Revision 14 posted to Frequently Asked Questions by Troy Wolbrink on 9/18/2017 8:04:41 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go. To learn more:

Read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Mon, 18 Sep 2017 20:04:33 GMT

Revision 13 posted to Frequently Asked Questions by Troy Wolbrink on 9/18/2017 8:04:33 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

The DonorHub API Approach

If you want to support the largest number of organizations with your app, this is the best way to go. To learn more:

Read the: DonorHub API Documentation

The SOAP/XML Approach

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

The TntConnect DataSync model

As an alternative to SOAP/XML with support for Single Sign-on, you can also programatically query donation information the same way TntConnect does. Here's documentationion on how this protocol works:
http://www.tntware.com/tntmpd/faqs/en/how-can-i-make-my-organization-s-online-donation-system-compatible-with-tntmpd.aspx

To know the Query.ini URL of your organization, in DonorHub Lite, under the "Tools" menu, click on "View Web URLs". The query.ini url of the demo Staff Portal is here:
https://dataserver.tntware.com/dataserver/test/dataquery/TntQuery.aspx

One advantage of using the TntConnect DataSync programming model is that you can support a larger variety of organizations (not just those that use DonorHub Lite). Here's an actively maintained list of organizations that use TntConnect, along with their query.ini URL:
http://download.tntware.com/tntconnect/TntConnect_Organizations.csv

The main disadvantage of this approach is that you must ask the user for their login and password. In other words, if your writing a web application that is already GCX Single Sign-on enabled, the SOAP/XML api can allow you to query the user's data without prompting them for credentials, but the TntConnect DataSync api would require you to ask the user for their credentials.

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Thu, 14 Sep 2017 16:56:36 GMT

Revision 12 posted to Frequently Asked Questions by Troy Wolbrink on 9/14/2017 4:56:36 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

SOAP/XML

Here's a demo of the Staff Portal:
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

The TntConnect DataSync model

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Thu, 14 Sep 2017 16:56:03 GMT

Revision 11 posted to Frequently Asked Questions by Troy Wolbrink on 9/14/2017 4:56:03 PM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

SOAP/XML

DonorHub Lite provides a SOAP/XML end point that other web applications can use to query donation data. The Staff Portal which is included with DonorHub Litegets all of its data exclusively through this web service. If you can see something on the Staff Portal, you can programmatically retrieve the same information.

Here's a demo of the Staff Portal:
https://dataserver.tntware.com/dataserver/test/staffportal/default.aspx<o:p></o:p>
https://www.mytntware.com/dataserver/test/staffportal/default.aspx

Here are demos of the SOAP web service endpoints where the Staff Portal gets its data:
https://dataserver.tntware.com/dataserver/test/dataquery/dataqueryservice.asmx
https://dataserver.tntware.com/dataserver/test/gcxauthentication/gcxauthenticationservice.asmx

[Caveat: The "Demo" Staff Portal uses a special "Test Authentication" and not "GCX Authentication" service which is available here.]
https://www.mytntware.com/dataserver/test/dataquery/dataqueryservice2.asmx

You'll notice that the "dataquery" folder is next to the "staffportal" folder. If you have a Staff Portal, url, replace "staffportal/*" in your url with "dataquery/dataqueryservice.asmx" "dataquery/dataqueryservice2.asmx" and you'll have your own SOAP endpoint.

The Staff Portal works with GCX a single sign on provider. The main SOAP endpoint has a SiteProperties informational record you can request. It includes the URL to the authentication provider under "SSOProvider". The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, it authenticates viaGCX single sign on the authentication provider and gets a service ticket. It passes in the service name and service ticket to the Data Query SOAP method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

The Staff Portal is a good working model on how to use the web services. If you'd like to look over the Staff Portal source code, it's available here (written in Delphi.NET as an ASP.NET application):
https://dataserver.tntware.com/dataserver/test/staffportal/staffportal_source.zip

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

The TntConnect DataSync model

As an alternative to SOAP/XML with support for GCX Single Sign-on, you can also programatically query donation information the same way TntConnect does. Here's documentationion on how this protocol works:
http://www.tntware.com/tntmpd/faqs/en/how-can-i-make-my-organization-s-online-donation-system-compatible-with-tntmpd.aspx

Can I programmatically query the the donation data from another application? If so, how?

Troy Wolbrink — Fri, 23 Sep 2016 04:06:44 GMT

Revision 10 posted to Frequently Asked Questions by Troy Wolbrink on 9/23/2016 4:06:44 AM

Can I programmatically query the the donation data from another application? If so, how?

Filed under: SOAP, XML, API, Web Service

SOAP/XML

DonorHub Lite provides a SOAP/XML end point that other web applications can use to query donation data. The Staff Portal which is included with DonorHub Lite gets all of its data exclusively through this web service. If you can see something on the Staff Portal, you can programmatically retrieve the same information.

Here's a demo of the Staff Portal:
https://dataserver.tntware.com/dataserver/test/staffportal/default.aspx<o:p></o:p>

[Caveat: The "Demo" Staff Portal uses a special "Test Authentication" and not "GCX Authentication" service which is available here.]

You'll notice that the "dataquery" folder is next to the "staffportal" folder. If you have a Staff Portal, replace "staffportal/*" in your url with "dataquery/dataqueryservice.asmx" and you'll have your own SOAP endpoint.

The Staff Portal works with GCX single sign on. The main way authentication works with the DataQuery service is through a session id. Let me explain: When the user comes to the Staff Portal, it authenticates via GCX single sign on and gets a service ticket. It passes in the service name and service ticket to the Data Query method "Login(ServiceName, ServiceTicket)" which returns a SessionID, UserName, and UserIsRegistered. You need to persists the SessionID as this is used for all subsequent method calls. If the user is not registered, you need to prompt the user for a registration code and submit it to the method "RegisterUser(SessionID, RegistrationCode)" until the user is registered.

Trusted Portal URL Prefixes

To ensure that only trusted web applications are querying a user's donation data on their behalf (via the SOAP/XML api), DonorHub Lite requires you to maintain a list of "URL Prefixes". This is available under: Tools | System Setup | Portal. Here you'll notice a link to "(edit prefix list)" and a link to "(view log)". When you're first getting started the "view log" option is handy as you can see exactly what's being attempted (but not "accepted"). If you see your portal in the log, copy the left most significant part of the URL (enough to make it "trusted" and add it to the list of trusted prefixes.

The TntConnect DataSync model

One advantage of using the TntConnect DataSync programming model is that you can support a larger variety of organizations (not just those that use DonorHub Lite). Here's an actively maintained list of organizations that use TntConnect, along with their query.ini URL:
http://download.tntware.com/tntconnect/TntConnect_Organizations.csv

The main disadvantage of this approach is that you must ask the user for their login and password. In other words, if your writing a web application that is already GCX Single Sign-on enabled, the SOAP/XML api can allow you to query the user's data without prompting them for credentials, but the TntMPD Query.ini TntConnect DataSync api would require you to ask the user for their credentials.

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach (preferred)If you want to support the largest number of organizations with your app, this is the best way to go. To learn more, read the: DonorHub API Documentation

The SOAP/XML Approach (obsolete)

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach (preferred)

The SOAP/XML Approach (obsolete)

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach (preferred)

The SOAP/XML Approach (obsolete)

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach (preferred)

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach (preferred)

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

The DonorHub API Approach

The SOAP/XML Approach

Trusted Portal URL Prefixes

The TntConnect DataSync model

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

SOAP/XML

Trusted Portal URL Prefixes

The TntConnect DataSync model

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

SOAP/XML

Trusted Portal URL Prefixes

The TntConnect DataSync model

Can I programmatically query the the donation data from another application? If so, how?

Can I programmatically query the the donation data from another application? If so, how?

SOAP/XML

The DonorHub API Approach (preferred)
If you want to support the largest number of organizations with your app, this is the best way to go.

To learn more, read the: DonorHub API Documentation