Difference between revisions of "API Details"
From Charitylog Manual
(→API Entities) |
|||
| (73 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:helpheader_small.png|right]] | [[File:helpheader_small.png|right]] | ||
| − | + | The API enables technical users capable of writing their own applications to [[Integrations|integrate]] with their Charitylog or Crossdata instance without having to log in to the web interface. It is a RESTful API using JSON over https. For prices, please call the office. To enable API users please see [[Users#3rd_Party_System_Access|Users]]. | |
| + | =General Concepts= | ||
| + | [[Why_use_an_API]] | ||
| − | [[ | + | [[API Dictionaries]] |
| + | |||
| + | [[API Authentication]] | ||
| + | |||
| + | =API Entities= | ||
| + | The API is based around various entities. To avoid breaking changes, the names in the API are fixed. If you are a developer talking to end users, it's useful to know that many features have different names in the web application, particular because many features can be renamed by a local admin. | ||
| + | {| class="wikitable" style="margin:auto" | ||
| + | |- | ||
| + | ! API name !! Description !! Renamable in web app? !! Typical names in web app | ||
| + | |- | ||
| + | | [[API_Classification_Codes|classification_codes]] || A tiered coding system used to classify done_contacts and referrals|| Y || Classification code, enquiry codes | ||
| + | |- | ||
| + | | [[API_clients|clients]] || Organisations/people that are people, e.g. clients, staff volunteers etc. || Y || Clients, Service Users, Staff, Volunteers | ||
| + | |- | ||
| + | | [[API_clinics|clinics]] || Group Activities || N || Clubs and Clinics | ||
| + | |- | ||
| + | | [[API_done_contacts|done_contacts]] || Completed actions || N || Contacts | ||
| + | |- | ||
| + | | [[API_due_contacts|due_contacts]] || Outstanding actions that typically make up the Action List in the web application || N || Outstanding actions | ||
| + | |- | ||
| + | | [[API:_Extension_Databases| extension_databases]] || Used to create your own data structures for forms etc || N || Extension Databases | ||
| + | |- | ||
| + | | [[API_external_referrals|external_referrals]] || Referrals collected externally, e.g. a self-referral form on your website || N || Inbound Referrals | ||
| + | |- | ||
| + | | [[Project_Set_Up|project]] || A service your organisation provides || Y || Project, Service, Department | ||
| + | |- | ||
| + | | [[API_referrals|referrals]] || Groups of done_contacts and due_contacts || Y || Referrals, Cases, Enquiries | ||
| + | |- | ||
| + | | [[API_relationships| relationship_details]] || Relationships between 2 people, e.g. parent, social worker, carer etc || N || Relationships | ||
| + | |- | ||
| + | | [[API_schedules|schedules]] || Roster job cards || N || Jobs cards is not renamable, but the workers are, e.g. Home Helper Job Cards, Support Worker Job Cards etc | ||
| + | |- | ||
| + | | [[Referral_Templates#The_Stages.2FStatuses|stage]] || A stage on a template, e.g. Initial Assessment || N || Stage | ||
| + | |- | ||
| + | | status || A broad grouping of a stage, e.g. Being Supported, Not For Reports etc || N || Status | ||
| + | |- | ||
| + | | [[Referral_Templates|template]] || A workflow, e.g. a collection of stages to guide you through a case || N || Template | ||
| + | |- | ||
| + | | [[API_workers|workers]] || People who work on schedules || Y || Home Helpers, Support Workers, Carers | ||
| + | |} | ||
| − | [[API | + | =Other= |
| + | |||
| + | [[API: File Uploads| File Uploads]] | ||
| − | + | =Reading data (GETs)= | |
[[API Filters]] | [[API Filters]] | ||
| − | [[Selecting Specific Fields | + | [[API: Selecting Specific Fields| Selecting Specific Fields]] |
| − | [[ | + | [[API: Reporting| Running Reports]] |
| − | [[ | + | =Writing data (POSTs and PUTs)= |
| + | [[API: Creating Records| Creating Records]] | ||
| − | [[ | + | [[API: Updating Records| Updating Records]] |
| − | [[ | + | [[API: External Referrals| External Referrals]] |
| − | + | =Making the most of your data= | |
| − | [[ | + | [[Excel Power Query| Getting Started with Power Query with Excel]] |
| − | [[API | + | [[Power BI with Power Query| Getting Started with Power Query in Power BI Desktop]] |
| + | |||
| + | [[Power Query - How to's| How to achieve more with Power Query]] | ||
| + | |||
| + | =Purchasing and getting started= | ||
| + | [[API:_purchasing| Purchasing]] | ||
| + | |||
| + | [[Working_with_existing_API_partners| Working with existing API partners]] | ||
| + | |||
| + | [[API:_Sample_Calls| Sample Calls]] | ||
Latest revision as of 09:21, 15 August 2024
The API enables technical users capable of writing their own applications to integrate with their Charitylog or Crossdata instance without having to log in to the web interface. It is a RESTful API using JSON over https. For prices, please call the office. To enable API users please see Users.
Contents
General Concepts
API Entities
The API is based around various entities. To avoid breaking changes, the names in the API are fixed. If you are a developer talking to end users, it's useful to know that many features have different names in the web application, particular because many features can be renamed by a local admin.
| API name | Description | Renamable in web app? | Typical names in web app |
|---|---|---|---|
| classification_codes | A tiered coding system used to classify done_contacts and referrals | Y | Classification code, enquiry codes |
| clients | Organisations/people that are people, e.g. clients, staff volunteers etc. | Y | Clients, Service Users, Staff, Volunteers |
| clinics | Group Activities | N | Clubs and Clinics |
| done_contacts | Completed actions | N | Contacts |
| due_contacts | Outstanding actions that typically make up the Action List in the web application | N | Outstanding actions |
| extension_databases | Used to create your own data structures for forms etc | N | Extension Databases |
| external_referrals | Referrals collected externally, e.g. a self-referral form on your website | N | Inbound Referrals |
| project | A service your organisation provides | Y | Project, Service, Department |
| referrals | Groups of done_contacts and due_contacts | Y | Referrals, Cases, Enquiries |
| relationship_details | Relationships between 2 people, e.g. parent, social worker, carer etc | N | Relationships |
| schedules | Roster job cards | N | Jobs cards is not renamable, but the workers are, e.g. Home Helper Job Cards, Support Worker Job Cards etc |
| stage | A stage on a template, e.g. Initial Assessment | N | Stage |
| status | A broad grouping of a stage, e.g. Being Supported, Not For Reports etc | N | Status |
| template | A workflow, e.g. a collection of stages to guide you through a case | N | Template |
| workers | People who work on schedules | Y | Home Helpers, Support Workers, Carers |
Other
Reading data (GETs)
Writing data (POSTs and PUTs)
Making the most of your data
Getting Started with Power Query with Excel
Getting Started with Power Query in Power BI Desktop
How to achieve more with Power Query
