What costs will I incur?
The costs can be made up of two blocks:
-
Craftnote does not charge any costs for the current interface - extended functions or customisations may incur costs.
-
The provider of the industry software may charge a connection and/or licence fee. Craftnote has no influence on this, so the amount can vary individually. vary.
What about the security of the transmission?
Access to the Craftnote system via API is secured with special access data for the interface. The access data is defined by us for each company and sent to the customer once the interface has been activated. During operation, the data from the craftsman software is transferred via a secure https - connection.
I have my own software. Can I still use the interface?
Yes, that is possible. Via this link API keys can be created independently for your company via the web app. The API key is the key that is required to activate the API connection. However, this creation can only be carried out by the user with the owner role of the company. be carried out.
Where can I find the technical description for the interface?
On the developer platform GitHub we always provide the current version of the technical description. View documentation
How can I access the Craftnote API?
As a Craftnote user, you cannot simply access the API yourself and use or set it up yourself. This requires a partner company, such as such as your own ERP system is required. The data from the ERP system must then be sent programmatically to Craftnote (via the interface). The interface is designed so that it can be built and connected independently of the programming language. and can be connected.
How can I access my project data in Craftnote via the API?
In the interface, there are so-called endpoints for the projects and for every other function. endpoints. Each function therefore corresponds to an endpoint. For the creation of a project and the associated header data (project name, ID number, address, contact person) there is an end point, just like for file storage or time recording. time recording.
The endpoint is accessed via /projects. The details are stored in the interface description.
How does the setup process work?
As a Craftnote user, you ask your software partner whether an interface exists exists or take a look at our existing interface partner website to see to see if their software is listed.
If an interface does exist, please contact the listed partner directly contact to clarify the setup and details. If there is no interface yet available, please get in touch with your service provider or contact person from the ERP system to find out whether an interface is desired.
We clearly position ourselves as an open system that wants to exchange information, but to develop a functioning system, you also need the other side.
So where does the data come from and is it transmitted to Craftnote? If your software partner wants to develop an interface (this is often associated with associated with costs. How high these are depends on the software partner and not from Craftnote) then you can contact us again at schnittstelle@mycraftnote.de contact us. We will be happy to assist you and your software partner with the implementation.
Who do I contact if I have questions about customisations or new functions?
Our colleagues are at schnittstelle@mycraftnote.de and will be happy to answer any questions about a possible development process.
How can I handle errors that occur during communication with the API?
Our API automatically provides so-called logs that describe the type of error. If problems really do occur, you are welcome to contact us at any time at hilfe@craftnote.de and we will take care of your request.
What scope of services does the API include?
- Creating, modifying and archiving projects (including all header data). Projects can also be read from Craftnote so that new information can be can be transferred back from projects.
- Management of project members (internal only): Employees can be added and removed added to and removed from projects using the API.
- Project status management: New statuses can be created, existing statuses can be edited and deleted.
- Files and folders can be created, moved and updated in the project file storage and updated (deletion is not possible). The files can then also be transferred to an external software system (e.g. an ERP system). Access management is also possible here.
- Times can be created, changed and deleted for projects. The recorded project times can then also be read out in order to write invoices and finalise invoices and finalise payroll accounting.
You can also find more information on our website.