Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions API.md
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.