Een collectie van de beschikbare Infradock API’s eindpunten
Base URLs
| Environment | Base URL |
|---|---|
| Development | https://api-dev.infradock.net |
| Test | https://api-tst.infradock.net |
| Acceptance | https://api-acc.infradock.net |
| Production | https://api.infradock.net |
Project
Endpoint:
/casemanagement/v1/project
Description
Maakt een nieuw Infradock project aan met de meegegeven projectinformatie. Het endpoint geeft een InfradockProjectId terug als het succesvol is.
Project
Endpoint:
/v1/project
Description
Haalt een gepagineerde lijst van Infradock projecten op. Projecten kunnen worden gefilterd op Infradock-Project-ID, projectfase en raamovereenkomst. Het antwoord bevat projectdetails, deelnemers, locatiegegevens en pagineringsinformatie.
Project - Medewerkers
Endpoint:
/casemanagement/v1/project/{infradock-id}/medewerkers
Description
Voegt één of meer gebruikers toe aan een bestaand Infradock project. Gebruikers worden geïdentificeerd aan de hand van het e-mailadres.
Project - Netdeel - Inkooporder
Endpoint:
/v1/project/netdeel/inkooporder
Description
Hiermee wordt informatie over inkooporders gekoppeld aan netdelen van een project. Het verzoek identificeert het project en de begrotingversie en specificeert de inkooporder en positie voor elke classificatie.
Begroting
Endpoint:
/v1/begroting/{idnummer}
Description
Haalt een begroting op dat de status “Verwerkt” heeft bereikt. Het antwoord bevat informatie over de aannemer van het project, evenals disciplines, secties, netdelen, diensten, clusters, maakproducten en materialen, inclusief hoeveelheden en prijsinformatie.
Materiaal - Prijs
Endpoint:
/contracten/v1/contract/{contractnummer}/materiaalprijsclassificatie
Description
Voegt de prijs van een materiaal binnen een contract toe of werkt deze bij. De prijs kan worden gekoppeld aan een specifieke classificatie en een optionele geldigheidsperiode. De opgegeven datums moeten binnen de contractperiode vallen. Indien er geen geldigheidsperiode wordt meegegeven, zal de begin- en einddatum van het contract worden aangehouden voor de geldigheid van het materiaal.
Materiaal
Endpoint:
/masterdata/v2/materiaal/{artikelnummer}
Description
Maakt een nieuw materiaal aan of werk een bestaand materiaal bij op basis van het opgegeven artikelnummer. Het verzoek bevat de omschrijving, eenheid, het type, de discipline, de status, de levertijd, bestelbeperkingen, de geldigheidsduur en een eventueel vervangend artikel.
Materiaal
Endpoint:
/masterdata/v2/materiaal/{artikelnummer}
Description
Werkt een bestaand materiaal bij aan de hand van het opgegeven artikelnummer. Alle velden in het verzoek zijn optioneel, waardoor individuele materiaaleigenschappen kunnen worden gewijzigd zonder de volledige materiaaldefinitie op te geven. Alleen de velden die in het verzoek zijn opgenomen, worden gevalideerd en opgeslagen.
Materiaal
Endpoint:
/masterdata/v2/materiaal
Description
Haalt een gepagineerde lijst met materialen op voor een opgegeven regiebedrijf. Materialen kunnen worden gefilterd op artikelnummer, type, aannemer, datum en actieve status. Het endpoint kan optioneel alleen materialen ophalen die sinds een bepaalde datum zijn gewijzigd.
Levering
Endpoint:
/logistiek/v1/levering
Description
Met deze API wordt een levering aangemaakt voor een bestaande Infradock bestelling. Het verzoek identificeert de bestelling en met het leveringsreferentienummer van het regiebedrijf, het type update (LEV of GA) en de bij de levering inbegrepen materialen en hoeveelheden bevatten. Bij een succesvol verzoek wordt de Infradock referentie van de nieuw aangemaakte levering geretourneerd.
Levering
Endpoint:
/logistiek/v1/levering/{referentie-infradock}
Description
Werkt een bestaande levering bij die wordt geïdentificeerd aan de hand van de Infradock referentie. De update bevat het type leveringsupdate (GA), evenals de materialen en hoeveelheden.
Bestelling
Endpoint:
/v1/bestelling/{referentie-infradock}
Description
Werkt de status van een bestaande bestelling bij aan de hand van het Infradock referentienummer. Dit endpoint wordt specifiek gebruikt om de bestelstatus te wijzigen naar “geleverd”.
File
Endpoint:
/v1/file
Description
Genereert een signed URL voor toegang tot een rapportagebestand. Het verzoek specificeert welk beschikbaar bestand moet worden opgehaald, en het antwoord levert een tijdelijke URL op, samen met het tijdstip van de laatste wijziging van het bestand.
Token
Endpoint:
/session/token
Description
Authenticeert op basis van de gegeven authenticatie gegevens en geeft een sessie token terug als de authenticatie succesvol is. Het endpoint verwacht een Basic Authentication token in de Authorization header van de aanvraag en een API key in de X-API-Key header.
Token Validate
Endpoint:
/token/validate
Description
Valideert het sessie token dat via de Authorization header is aangeleverd. Het antwoord geeft aan of het token geldig is en bevat de bijbehorende claims en de vervaldatum/-tijd.