Skip to content

Home

Jump to bottom
Abdullah Cemil AKÇAM edited this page Nov 11, 2024 · 15 revisions

Welcome to the HPC.tools API Wiki.

Here you will find documentation and guides to help you use the API located at https://api.hpc.tools/.

(This API powers the OCHA Financial Tracking Service (FTS), Humanitarian Action, and a number of other OCHA web properties.)

The documents you find here are supplemental to the Swagger API Documentation that's published at https://api.hpc.tools/docs/v2/.

We're writing documents on an as-needed basis as we find gaps in our documentation or commonalities between requests for guidance on how to use our API.

If you would like to reach out for support, or suggest additional guides or themes that could be added to this Wiki, please feel free to email api-support@hpc.tools. Please note though that priority will be given to OCHA Field Colleagues as far as response time is concerned, but we will try to respond in a swift manner to all emails.

Guides

Using the HPC API in PowerBI or Excel

Upcoming Changes to the API

We have recently announced a number of upcoming changes to the HPC API, including the development of v4 of the API that will use GraphQL at its core.

These changes are at the very early planning and development stages at the moment, and are not yet ready to be tested or used, so for the time being we recommend continuing to use the v2 endpoints that are documented in the Swagger documentation at https://api.hpc.tools/docs/v2/ and in this wiki.

If you'd like to keep updated as to when these new endpoints will become available for early user feedback or use, please see the section below.

Keeping Up-To-Date

We have introduced some mailing lists that we will now be using to keep API users up-to-date, and engage with users for early testing and feedback of new API features.

If you would like to join either of these mailing lists, please send an email to api-support@hpc.tools with your request:

  • api-announce@hpc.tools

    This mailing list will be used for official announcements from the HPC.tools team regarding changes in the API, including new features and deprecation notices.

  • api-discuss@hpc.tools

    This mailing list allows for open discussion between different users of the HPC API, as well as the development team. Feel free to use this mailing list to ask for advice on how to use the API.

    We will be using this mailing list to solicit early feedback for the v4 API as we continue to plan and develop it.

Clone this wiki locally