User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
api [2019/10/24 13:35]
flack [Quote Request API]
api [2020/04/22 12:01] (current)
flack
Line 1: Line 1:
 API base url: https://​mcule.com/​api/​v1/​ API base url: https://​mcule.com/​api/​v1/​
  
-Examples are demonstrated with [[https://​github.com/​jkbrzt/​httpie|HTTPie]].+Examples are demonstrated with [[https://​httpie.org|HTTPie]]
 + 
 +Only the most important request/​response headers are shown in the examples below.
  
 ====== Response status codes ====== ====== Response status codes ======
Line 63: Line 65:
             ],              ], 
             "​last_updated":​ "​2017-09-18", ​             "​last_updated":​ "​2017-09-18", ​
-            "​name":​ "Mcule Purchasable (full)"​+            "​name":​ "Mcule Purchasable (full)"​
 +            "​public":​ true
         },          }, 
         {         {
Line 83: Line 86:
             ],              ], 
             "​last_updated":​ "​2017-09-18", ​             "​last_updated":​ "​2017-09-18", ​
-            "​name":​ "Mcule Purchasable (in stock)"​+            "​name":​ "Mcule Purchasable (in stock)"​
 +            "​public":​ true
         }         }
     ]     ]
 } }
 </​code>​ </​code>​
 +
 +If you call this API endpoint as an authenticated user (=you provide a [[api#​authentication|valid token]]) you might get additional private entries if you have permission to access them.
  
  
Line 229: Line 235:
  
 Authentication is currently a token based authentication. Authentication is currently a token based authentication.
-If you would like to access our protected API endpoints, please drop us an email at support@mcule.com and we can provide you with token.+If you would like to access our protected API endpoints, please drop us an email at support@mcule.com ​including a brief summary on why and how you would like to use the API. We'll review your request, and if accepted, ​we'​ll ​provide you with an access ​token which you can use to call the API as an authenticated user.
  
 Once you have a valid token you have to send it in the Authorization header: Once you have a valid token you have to send it in the Authorization header:
api.1571916937.txt.gz · Last modified: 2019/10/24 13:35 by flack