{"info":{"_postman_id":"49874c54-d739-457a-8fb7-65d3a43e57c4","name":"Lumino","description":"

The Lumino API allows you to easily access data stored in Lumino, create new data or change it.

Overview

You need a valid API Key to access most of the functions. You can get it using the /auth/login endpoint with your normal credentials which will return your key.
Alternatively you can use an API token which is created on your profile page.
The Lumino API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.
Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an \"result\": \"failed\" key in the JSON response, together with another key \"error\" that contains some details.
If your request succeeds, you will find a key \"result\": \"success\" in the JSON response. In case you request returned some data, you will find it in a key \"data\".
The official REST API base URLs are:
- https://api.lumino.cloud/api for production
- https://api-dev.lumino.cloud/api for development
\n

Authentication

The API Key needs to be submitted as part of every request in form of an X-Access-Token request header. The API Key tells the server who you are and what kind of access to the API you have. It also has a limited validity so make sure you login for every session or at least once every 24h.

The API Token is valid forever until you delete it from your profile again. It must be submitted in form of an X-API-Token request header.

Clients

In case your account is member of more than one client, you also have to specify an X-Request-Client request header that specifies the Id of the desired client. Omitting this request header will serve information of your default client. To get a list of all your clients and Ids, use the /auth/myclients endpoint.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Clients","slug":"clients"}],"owner":"4554799","collectionId":"49874c54-d739-457a-8fb7-65d3a43e57c4","publishedId":"SzKbLFKN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0080ff"},"publishDate":"2023-10-29T09:41:13.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login (with 2FA)","id":"6cde1f75-4dc2-4504-94f3-a08cd4ab5aff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": \"\",\n \"password\": \"\",\n \"client\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/login2fa","description":"

Login to the system using username and password. This will return only a success message but no token. Instead it will trigger an email to the account containing a 2FA Code that needs to be sent back using the \"Confirm 2FA\" endpoint below.

This endpoint also has an optional \"client\" parameter that is strongly encouraged. Specifying a client will cause the token that will be returned by \"Confirm 2FA\" endpoint to be restricted to a single client. No other clients can be accessed using it. Only omit this parameter if you really need elevated access privileges across all clients. The user will be told about this in the 2FA email so can decide to give full access or not.

\n","urlObject":{"path":["auth","login2fa"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cde1f75-4dc2-4504-94f3-a08cd4ab5aff"},{"name":"token","id":"9c744032-bd04-419c-ac4a-dc16e4257b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": \"\",\n \"password\": \"\",\n \"client\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/login2fa","description":"

\n","urlObject":{"path":["auth","login2fa"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c744032-bd04-419c-ac4a-dc16e4257b09"},{"name":"Confirm 2FA","id":"87d5512e-ddfa-4215-a7e7-0f513afbf437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": \"\",\n \"code\": \"<2fa code>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/confirm2fa","description":"

Use this endpoint to send back the 2FA code, the user received by mail. On successful verification, this will send back a token to use as authentication for all other endpoints.

\n","urlObject":{"path":["auth","confirm2fa"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"87d5512e-ddfa-4215-a7e7-0f513afbf437"},{"name":"Get current user info","id":"fc2df8a5-6f43-4e1e-830f-a907a65362fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-token","value":""}],"url":"{{baseUrl}}/auth/me","description":"

Return information about current user

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-access-token"},{"key":"value","value":"{{accesstoken}}"}]},"isInherited":true,"source":{"_postman_id":"49874c54-d739-457a-8fb7-65d3a43e57c4","id":"49874c54-d739-457a-8fb7-65d3a43e57c4","name":"Lumino","type":"collection"}},"urlObject":{"path":["auth","me"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"55f60dac-af87-414b-beff-73fa2314a4d5","name":"Successful return of identity","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/auth/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\",\n \"data\": {\n \"_id\": \"5ce5441c2a4a19ed6ec1f0a9\",\n \"name\": \"Username\",\n \"client\": \"Companyname\",\n \"clientId\": \"5d83ef7e43e6a1bbcc69793f\",\n \"admin\": false,\n \"superadmin\": false,\n \"account\": \"user@example.com\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"fc2df8a5-6f43-4e1e-830f-a907a65362fb"},{"name":"Get my clients","id":"10019fa5-76d6-4ac3-8363-1a69062a51bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/auth/myclients","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-access-token"},{"key":"value","value":"{{accesstoken}}"}]},"isInherited":true,"source":{"_postman_id":"49874c54-d739-457a-8fb7-65d3a43e57c4","id":"49874c54-d739-457a-8fb7-65d3a43e57c4","name":"Lumino","type":"collection"}},"urlObject":{"path":["auth","myclients"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"10019fa5-76d6-4ac3-8363-1a69062a51bf"},{"name":"Register","id":"e5c72c93-a583-424e-b44a-05048906dc7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": \"\",\n \"password\": \"mypassword\",\n \"name\": \"\",\n \"country\": \"\"\n \"clientInvitationToken\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/register","description":"

This request will create a new user registration. The field account specified an email address and will be tested for email format. A confirmation email is sent to this address for confirmation before the account can be activated.\nThe field name should the the full name of the user.\nThe clientInvitationToken field is optional and is used for for adding a new user directly to an existing client instead of creating a new client for that user.

\n","urlObject":{"path":["auth","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5c72c93-a583-424e-b44a-05048906dc7e"},{"name":"Confirm email","id":"4997a35f-7773-4fb1-a022-98ad1eb3e472","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/auth/confirmemail/:token","description":"

This request is used to confirm an email address. The token is contained in the email that is sent upon registration of a new user. In case the user was registered including a clientInvitationToken, the user is automatically approved and activated. Otherwise it will need to be approved by an administrator.

\n","urlObject":{"path":["auth","confirmemail",":token"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"string","value":"","key":"token"}]}},"response":[],"_postman_id":"4997a35f-7773-4fb1-a022-98ad1eb3e472"},{"name":"Forgot password","id":"5342fdeb-2b9f-4660-8b90-5b97166160fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": \"mail@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/forgotpassword","description":"

If a user forgets his password, this api endpoint can be used to send an email to set a new password. Submit the email address and if the user is found in the database, an email is sent with a reset token.\nThis token can be used in the /auth/setnewpassword endpoint. If the user cannot be found in the database, a success message is also sent.

This endpoint can be used to set a new password for a user. Submit the token from the email sent by the /auth/forgotpassword endpoint together with a new password.

(Required)

\n"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My item\",\n\t\"type\": \"Image\",\n \"itemtemplate\": \"optional item template id\",\n\t\"folder\": \"parent folder Id or null\",\n\t\"public\": false,\n\t\"attributes\": {\n\t\t\"att1\": \"value\"\n\t},\n\t\"links\": [\n\t\t{ \"to\": \"item id\", \"usage\": \"type of usage\" }\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/item","description":"

Create a new item

(Required)

\n"}],"url":"{{baseUrl}}/item","description":"

Update an item