- Previous:
- Up:
- Next: Standards Documents
Compassion API Library
Compassion APIs enable developers from various communities to create applications in order to advance the mission of Compassion. The portal contains only private APIs.
Private APIs
Using Private APIs, International Partner organizations can retrieve information about children, their development center, local community and country of residence in order to be advocates for these children. Field office and implementing church staff can gain access to information such as which children in a particular project are scheduled for a case study update.
The Compassion API Library supports REST calls based upon the REST v1 Standard which supports both JSON in the response.
Compassion API Authentication
- All API calls need to include the authentication parameter
"&api_key=" +key
. - Many API calls require an OAuth Token. This is to protect the children which Compassion International supports.
Request Limit
- Limit calls to 5,000 per day, per API key
- Limit queries to 10 per second, per API key
When you reach 75% of your limit, Compassion International is notified and will contact you to determine what limits you need.
Case-Sensitive
The Compassion API REST URLs are case sensitive. Please copy the URL exactly how it is presented in the documentation.
Other
After requesting an API key, please be patient. It can take time for your API key to be activated.
- Previous:
- Up:
- Next: Standards Documents
Docs Navigation
- Compassion API Library
- Standards Documents
- Legacy APIs (Deprecating)
- Web Services Handshake (Legacy) - Notification and Command Messages
- Public API
- Private IPG APIs
- Private REST Services
- REST Get CDSP Implementor V1
- REST Get Child Case Study V1
- REST Get Child Exit Details V1
- REST Get Child Image V1
- REST Get Child Information V1
- REST Get Community V1
- REST Get Country V1
- REST Get CSP Implementor V1
- REST Get Local Church Partner V1
- REST Get Program Implementor V1
- REST Get Project Age Groups V1
- REST Get Child Image V1 - 2015/03
- Private Messaging APIs
- Quick Start Guide
- OffRamp Prerequisites and Setup
- IP OnRamp Service Configuration
- Available Message Types
- Message and Service Relationships
- Troubleshooting
- General Error Messages from Compass Party Host
- EsdMessageErrorMOE Sample
- Sample REST End-To-End Test Plan
- SOAP Wrapper Sample for Messages to GMC
- Allocate Child Message
- Cancel Commitment Message
- Commitment Canceled Message
- Commitment Created Message
- Constituent Created Message
- Constituent Updated Message
- Constituent Upserted Message
- Create Commitment Message
- Create Constituent Message
- Create Email Message
- Create Gift Message
- Deallocate Child Message
- Depart Child Message
- Email Created Message
- Email Updated Message
- Gift Created Message
- Update Child Message
- Update Constituent Message
- Update Email Message
- Upsert Constituent Message
- Update Project Message
- Private SOAP Services
- SOAP Get Child Exit Detail 201211
- SOAP Get Child Exit Detail 201310
- SOAP Get CDSP Implementor 201309
- SOAP Get Child Image 201211
- SOAP Get Child Case Study 201310
- SOAP Get Child Case Study 201412
- SOAP Get Child Information 201211
- SOAP Get Child Information 201310
- SOAP Get Community 201309
- SOAP Get Country Information 201104
- SOAP Get Local Church Partner 201309
- SOAP Get Program Implementor 201303
- SOAP Get Program Implementor 201309
- SOAP Get Project Age Group 201309
- Service Overview
- SOAP Get CSP Implementor 201309
- SOAP Get Child Image 201503
- Private USA APIs
- Private USA Web APIs
- private cornerstone connect messaging
- private cornerstone test
- public api
0 Comments
New comments are not being accepted at this time.