Getting Started

🔑 Getting access to GiroPro

The very first thing you need to get started is to be(come) a GiroPro customer. If you’re not a customer yet we’ll gladly give you a demo. Reach out to us here.

---

📄 API-definitions

Throughout this documentation we will reference endpoints of the GiroPro API. All endpoints can be found in the API Definitions section of the documentation.

All of these endpoints are defined in a Swaggerfile following OpenAPI Specification 3.0.0. The current version of this file can be viewed and downloaded from the BFF API reference for code-generation purposes.

---

✉️ PengineResult

All GiroPro responses are encapsulated in a PengineResult object. This object looks like this:

{
    "success": true,
    "httpStatusCode": 200,
    "errors": [],
    "totalCount": 0,
    "items": [
        // response data in here
    ],
}

“items” contains one or more data objects depending on the endpoint.