Overview over changes made to the Handyman API and Common API related to Handyman Office versions.
Detailed documentation is at:
| Common API | api.gsgroup.io |
| Handyman API |
Example: Dependent of Handyman API configuration in the Handyman ControlCenter |
Version 9.6.5
New features
Authorisation per endpoint
Det är nu möjligt att begränsa åtkomsten för varje slutpunkt när man använder auktorisering med token. Detta blir vanligtvis intressant när du behöver ge partners/entreprenörer åtkomst till din Handyman via API-åtkomst i ett speciellt integrationscenarie. Kontakta GSGroup för mer information om hur man använder den här funktionen.
Support for both internal and external address for HM-API URL
Beroende på infrastrukturen kan det vara nödvändigt att ha två URL:er konfigurerade om serverrapporter i Handyman Mobile inte kan nås med den aktuella API-URL:en. Konfigurationen görs i Handyman ControlCenter. Kontakta GSGroup om detta är ett problem.
ServiceBusSender
Handyman Office och Sync stöder att skicka meddelanden till Azure Service Bus för att signalera vilka order eller andra enheter som behöver exporteras från Handyman. Detta används i API-baserade integrationer för att ha en integrationsflöde baserat på meddelanden. Mer dokumentation kommer senare.
New APIs
| Endpoint | Purpose | Comment |
| weboffice/quotes |
|
|
| messagelogs | Insert messages to Handymans message log. |
Useful for logging exceptions from integrations so that it will be easier to troubleshoot. Also to be used for logging normal events related to import/export of data. See here for instructions on how to use |
Changes in existing APIs
| Endpoint | Change | Comment |
| all order endpoints with dates | DateTimeBehaviour paramteter is added to support writing and reading dates as UTC value |
Possible values:
|
|
SyncStatus field added |
0 = not sent to ERP For material and salary codes registrations, quantity should be <> 0 before sending to ERP.
When record is updated, it is automatically set to 2
See here for description of minimum records for updated SyncStatus. |
| orders | DoNotSetAsPassive is now handled as in the XML API. |
Set to "true" to avoid finished orders to på historical until ERP has completed the order. |
|
orders/salarycodes |
Removed requirement for mandatory fields
|
|
|
orders/material |
Removed requirement for mandatory fields
|
|
|
orders |
ExternaID will now not be overwritten if empty or not provided |
|
|
orders/document |
Metadata can now be changed without providing the document binary data |
|
|
orders |
Message field for orders is now supporting configuration per contract and concatenating with manual text:
|
|
|
Swagger-uppdatering - prefixet "parameter." har tagits bort från komplexa parameterobjekt |
||
|
|
Improved error feedback if post/get requests fail |
Versjon 9.6.4
Important fixes
| Endpoint | Fix | Comment |
| orders |
Plats skapar en ny adress varje gång. BackofficeID eller HsID hade ingen effekt. |
|
| settings |
Logo was not returned as image/binary |
Versjon 9.6.3
Important fixes
| Endpoint | Fix | Comment |
| orders |
InvoiceStatus was not updated |
|
| orders | EstimatedHours was mandatory field | Requirement removed |
| orders/material | locking rules was not correct | |
| orders | Location validation rules is too strict | Endast gemensam API. Använde samma regler som för kundadresser. Nu mindre strikt. |