AircotechniX BV API
Deze gids is ontworpen om ontwikkelaars te voorzien van een duidelijke en uitgebreide uitleg over het integreren van onze API in jouw applicaties. Hier vind je informatie over de beschikbare eindpunten, authenticatie, voorbeelden van verzoeken en antwoorden, en veelgestelde vragen. Of je nu een beginnende ontwikkelaar bent of een ervaren professional, onze documentatie helpt je om snel aan de slag te gaan en het meeste uit onze API te halen. Laten we beginnen!
Standaard Bearer Authenticatie
Inleiding
Bearer authenticatie is een populaire manier om toegang te verlenen tot API's. Het biedt een veilige manier voor clients om zich te authentiseren via tokens. Deze documentatie beschrijft de basisprincipes van bearer authenticatie, hoe je het kunt implementeren en gebruiken.Wat is Bearer Authenticatie?
Bearer authenticatie maakt gebruik van een token dat de client meestuurt bij elke aanvraag naar de server. Het token bevat informatie over de identiteit van de gebruiker en, indien van toepassing, rechten en privileges. U verkrijgt deze token op aanvraag bij AircotechniX BV.Gebruik API
Inleiding
U gebruikt bij elke request de aangeleverde Token door deze mee te geven in de header. De endpoint die u dient te gebruiken is https://api.aircotechnix.be/. Geef ook steeds de Modus mee waarmee u wil connecteren.Mode: getAll
Deze zal ALLE data ophalen afhankelijk van de GET parameter die u heeft mee gegeven in y of d.- zonder y: Verkrijgt u ALLE records uit het huidige jaar.
- y=jjjj: U verkrijgt ALLE records uit het aangegeven jaar. (bv. y=2023)
- y=all: U verkrijgt ALLE records.
- d=jjjj-mm-dd: U verkrijgt ALLE records voor de specifiek opgegeven dag.
HTTP Header
X-Authorization: Bearer uw token,
Mode: getAll
Endpoints
https://api.aircotechnix.be/https://api.aircotechnix.be/?y=jjjj
https://api.aircotechnix.be/?y=all
https://api.aircotechnix.be/?d=jjjj-mm-dd
JSON reply
[
{
"site:":"naam van de site",
"reference:":"referentie van de site",
"devices:":[
{
"name":"naam van het apparaat",
"location":"locatie van het apparaat",
"maintenance":[
{
"date":"datum uitvoering",
"number":"nummer onderhoudsfiche/rapport",
"sub type":"categorie van het onderhoud",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"workorders":[
{
"date":"datum uitvoering",
"number":"nummer werkbon",
"sub type":"categorie van de werkbon",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"certificates":[
{
"date":"datum uitvoering",
"number":"nummer van het attest",
"sub type":"categorie van het attest",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"tickets":[
{
"date":"datum ticket",
"number":"nummer van het ticket"
}
]
}
]
}
]
{
"site:":"naam van de site",
"reference:":"referentie van de site",
"devices:":[
{
"name":"naam van het apparaat",
"location":"locatie van het apparaat",
"maintenance":[
{
"date":"datum uitvoering",
"number":"nummer onderhoudsfiche/rapport",
"sub type":"categorie van het onderhoud",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"workorders":[
{
"date":"datum uitvoering",
"number":"nummer werkbon",
"sub type":"categorie van de werkbon",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"certificates":[
{
"date":"datum uitvoering",
"number":"nummer van het attest",
"sub type":"categorie van het attest",
"technician":"uitgevoerd door technieker",
"conform":"Ja/Nee/Leeg",
}
],
"tickets":[
{
"date":"datum ticket",
"number":"nummer van het ticket"
}
]
}
]
}
]
Mode: getFile
- f: de 'name' die u verkregen hebt bij getAll
HTTP Header
X-Authorization: Bearer uw token,
Mode: getFile
Endpoints
https://api.aircotechnix.be/?y=maintenance&f=xhttps://api.aircotechnix.be/?y=workorder&f=x
https://api.aircotechnix.be/?y=certificate&f=x
https://api.aircotechnix.be/?y=ticket&f=x
PDF reply
Indien succesvol zal er een PDF document als reply worden gegeven.
Info
Voor onderhoudsfiches en de tickets worden momenteel nog niet alle afbeeldingen meegenomen, dit probleem wordt onderzocht.
Offcanvas right
...