From 2e1814394c5a937498089c01bd326a3e1597d5d1 Mon Sep 17 00:00:00 2001 From: Lily Ye Date: Thu, 11 Dec 2025 11:47:06 -0600 Subject: [PATCH] Split API info from README to new doc For purposes of directly publishing .md files onto WordPress site, it is more convenient to split this part of the document off the main repo README. We don't need the info about the repo or the GitHub links that are contained in the first section, but do want the rest, which are nicely self-contained. --- API.md | 33 +++++++++++++++++++++++++++++++++ README.md | 33 --------------------------------- 2 files changed, 33 insertions(+), 33 deletions(-) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..96ebca3 --- /dev/null +++ b/API.md @@ -0,0 +1,33 @@ +# Accessing Data in the Philanthropy Data Commons Using the API + +This section describes using the PDC API to view or send data to the PDC. There +may be multiple ways to accomplish this in future. + +To use the PDC API to view changemaker data, see the [OpenAPI documentation for +the `GET /changemakers` endpoint +](https://api.philanthropydatacommons.org/#/Changemakers/getChangemakers). No +authentication is required to view changemaker data. + +To see more data or add data to the Philanthropy Data Commons, you will need a +User in the PDC system. Please use the [Contact +form](https://philanthropydatacommons.org/contact/) to describe your PDC user +story and that you would like to be added to the PDC. + +# Sending Data to the Philanthropy Data Commons Using the API + +Get a User that can log in as described above. + +Familiarize yourself with the central PDC service API by visiting the [OpenAPI +documentation at the PDC](https://api.philanthropydatacommons.org). The related +[(aspirational) Entity Relation Diagram +](https://github.com/PhilanthropyDataCommons/service/blob/main/docs/ENTITY_RELATIONSHIP_DIAGRAM.md) +helps see how data are modeled. + +Use the "Authorize" button in the upper right and click "Authorize" again (no +changes on the form are needed) to log in to the PDC. + +Use the [`POST /proposalVersions` endpoint +](https://api.philanthropydatacommons.org/#/Proposals/addProposalVersion) +to add data. Of course, there are multiple other things to add prior to using +this endpoint, as you can see in the required parameters here and the required +parameters of the related endpoints. diff --git a/README.md b/README.md index 1c5b19a..d7f23a8 100644 --- a/README.md +++ b/README.md @@ -17,36 +17,3 @@ For policies about data management, please see Visit https://philanthropydatacommons.org/ for a high-level overview of the PDC. -## Accessing Data in the Philanthropy Data Commons Using the API - -This section describes using the PDC API to view or send data to the PDC. There -may be multiple ways to accomplish this in future. - -To use the PDC API to view changemaker data, see the [OpenAPI documentation for -the `GET /changemakers` endpoint -](https://api.philanthropydatacommons.org/#/Changemakers/getChangemakers). No -authentication is required to view changemaker data. - -To see more data or add data to the Philanthropy Data Commons, you will need a -User in the PDC system. Please use the [Contact -form](https://philanthropydatacommons.org/contact/) to describe your PDC user -story and that you would like to be added to the PDC. - -## Sending Data to the Philanthropy Data Commons Using the API - -Get a User that can log in as described above. - -Familiarize yourself with the central PDC service API by visiting the [OpenAPI -documentation at the PDC](https://api.philanthropydatacommons.org). The related -[(aspirational) Entity Relation Diagram -](https://github.com/PhilanthropyDataCommons/service/blob/main/docs/ENTITY_RELATIONSHIP_DIAGRAM.md) -helps see how data are modeled. - -Use the "Authorize" button in the upper right and click "Authorize" again (no -changes on the form are needed) to log in to the PDC. - -Use the [`POST /proposalVersions` endpoint -](https://api.philanthropydatacommons.org/#/Proposals/addProposalVersion) -to add data. Of course, there are multiple other things to add prior to using -this endpoint, as you can see in the required parameters here and the required -parameters of the related endpoints.