What is an API?
- API is an Acronym for Application Programming Interface.
- APIs are used by software programmers to build software applications.
- APIs come in different forms
- .dll (dynamic link libraries)
- Javascript
- Web Services
Family Suite API Version 2
The Family Suite API Version 2 is the enhanced version of ParishSOFT Family Suite Version 1 built to simplify make use of API for our customers with detailed information on request and response of endpoints. Also, Family Suite API Version 2 allows to integrate with Microsoft Power Automate platform.
The Family Suite API’s (version 2) documentation can be viewed on the Swagger page.
The documentation is organized by Domain which is a category of data in the same manner as it was in Version 1, e.g. Families, Organizations.
Under each domain is the list of operations that can be performed in the Domain:
- Get Families
- Get Families/Groups
- Get Organizations
API Documentation
Note: Click the down carrot to expand each HTTP Verb to explore the values and data structure for each request.
Testing API Endpoints
- In Family Suite API Version 2, API key provided by ParishSOFT needs to pass on each request as Authorization header x-api-key.
- For the best experience testing the API we recommend using Postman.
Example 1
- Below example will elaborate how to call API decorated with HTTP Verb POST.
- Click the + in the tab region of Postman.
- Change the request type to POST.
- Enter the URL https://fsapi2.parishsoft.app/api/families/search
- Click the Headers tab and add a KEY value of Content-Type and a VALUE of application/json
- Click the Authorization tab, select API Key on Auth Type dropdown list, and enter API key provided by ParishSOFT on Value textbox.
- Click the Body tab.
- Under Body tab ensure the raw and JSON options are selected.
- Add Search parameters in JSON format to the text area as shown below.
- Click the Send button.
- The API should return a 200 OK response with Search result of Families.
Example 2
- Below example will elaborate how to call API decorated with HTTP Verb GET.
- Click the + in the tab region of Postman.
- Change the request type to GET.
- Enter the URL https://fsapi2.parishsoft.app/api/v2/families/9545 (Note: 9545 is placed for {familyId})
- Click the Authorization tab, select API Key on Auth Type dropdown list, and enter API key provided by ParishSOFT on Value textbox.
- For GET type, no need to set Body but make sure to add correct value on URL for placeholder mentioned in endpoint path e.g. {familyId}
- Click the Send button.
- The API should return a 200 OK response with Family details for specific Family Id.
Updated