Ultimaker API - Add new material

[hakanfa 1]

Hi,

I need to add new material to the UM S5 - as I have understood this can be done via this UM API. Can anyone show me in more detail how this can be done.

My first attempt was to create a XML file as below. (Observe, I need to add this to the UM S5, I know how to use Cura - will not serve my needs)

<?xml version='1.0' encoding='cp1252'?>

<fdmmaterial xmlns="http://www.ultimaker.com/material">

  <metadata>

    <name>

      <brand>Colorfabb</brand>

      <material>PLA</material>

      <color>Copper</color>

      <label>Colorfabb Copper</label>

    </name>

    <version>1</version>

    <GUID>eaf3d290-843f-4955-8fbd-5431073071e7</GUID>

    <description />

    <adhesion_info />

    <color_code>#B87333</color_code>

  </metadata>

  <properties>

    <diameter>2.85</diameter>

    <density>3.90</density>

  </properties>

  <settings>

    <setting key="print temperature">210.0</setting>

    <setting key="retraction speed">40.0</setting>

    <setting key="retraction amount">1.0</setting>

    <setting key="standby temperature">175</setting>

    <setting key="heated bed temperature">60.0</setting>

  </settings>

</fdmmaterial>

 

When I try to upload this file I get :

{ "message": "Authorization required." }

 

What should I do differently?

Best regards,

Hokki

 

 

[Smithy 1,144]

You have to authenticate yourself for most write requests.

 

Check out these APIs:

 

This generates new id/key combination that has to be used as username/password in the digest authentication on certain APIs.

 

 

[hakanfa 1]

Hmm, yes I tried that. with ultimaker/ultimaker -> no luck. 

[Smithy 1,144]

ultimaker/ultimaker is not a valid id/key combination fo the apis, it is for SSH login.

You have to carefully read the description of the authentication api I mentioned above. 

First of all you have to make an auth request with your parameters like user, application. Then you have to confirm this request on the printer display it self. 

 

Only then can you use the id/key combination to authenticate your other API calls.

[hakanfa 1]

OK, sorry my mistake. So I did like this - safari/hakanfa, confirmed in UM S5. So far so good. But when trying the "post material" I still get the Authorization required message. Should I put the user info in the XML file somehow?

 

Thank you very much for swift replies!

 

[Smithy 1,144]

When you did the auth request, you got a json response with id and key.

{
  "id": "string",
  "key": "string"
}

This is your username (id) and password (key).

Then you have to use both parameters for the http digest authentication. How you have to use the digest authentication depends on your scripting language. 

 

For Python (untested, just out of my head):

from requests.auth import HTTPDigestAuth
url = 'http://<printer-ip>/api/v1/materials'
requests.get(url, auth=HTTPDigestAuth('user', 'pass'))

 

[Smithy 1,144]

And if you don't use any scripting language, but just the browser, then you need to enter id/key in the popup window which is shown after calling the api.

 

If no popup is shown, then close your browser and open it again.

[hakanfa 1]

Ok, now I understand. - thank you, will try it out as soon as I come home.

I will just call the post material API via the browser. The purpose of doing this is that I use the UM material station - all works fine with NFC tagged filaments but I use a lot of 3rd party filaments like Colorfabb. If you have many “generic pla:s” the Cura/UM does not know which to choose. One update proposal to Cura would be ability to choose from what bay to load the filament - not only the type of filament.

[Smithy 1,144]

44 minutes ago, hakanfa said:

If you have many “generic pla:s” the Cura/UM does not know which to choose. One update proposal to Cura would be ability to choose from what bay to load the filament - not only the type of filament.

I guess this feature will come in future firmware/Cura updates.

[robinmdh 100]

You can also import the material into cura, if it is connected to your printer then upon restarting cura it will sync materials with the printer.