|
339 | 339 | <a href="#getting-started" class="toc-h1 toc-link" data-title="Getting Started">Getting Started</a>
|
340 | 340 | <ul class="toc-list-h2">
|
341 | 341 | <li>
|
342 |
| - <a href="#getting-an-api-key" class="toc-h2 toc-link" data-title="Getting an API key">Getting an API key</a> |
| 342 | + <a href="#method-1-default-getting-an-api-key" class="toc-h2 toc-link" data-title="Method #1 (default): Getting an API key">Method #1 (default): Getting an API key</a> |
| 343 | + </li> |
| 344 | + <li> |
| 345 | + <a href="#method-2-oauth2-develop-integrations-for-simplyprint" class="toc-h2 toc-link" data-title="Method #2: OAuth2 - develop integrations for SimplyPrint">Method #2: OAuth2 - develop integrations for SimplyPrint</a> |
343 | 346 | </li>
|
344 | 347 | <li>
|
345 | 348 | <a href="#the-base-url" class="toc-h2 toc-link" data-title="The base URL">The base URL</a>
|
@@ -562,10 +565,18 @@ <h1 id='getting-started'>Getting Started</h1>
|
562 | 565 | <p>Welcome to the <strong>SimplyPrint API</strong>!</p>
|
563 | 566 |
|
564 | 567 | <p>This documentation goes through authenticating and how to use the API. To get started you'll need an API key.</p>
|
565 |
| -<h2 id='getting-an-api-key'>Getting an API key</h2> |
| 568 | +<h2 id='method-1-default-getting-an-api-key'>Method #1 (default): Getting an API key</h2> |
566 | 569 | <p>To get an API key you'll need a SimplyPrint account that is either a member of an organization or has at least the <a href="https://simplyprint.io/#pricing">SimplyPrint Pro plan</a>.</p>
|
567 | 570 |
|
568 | 571 | <p>To create your own API key you first need a SimplyPrint account, you can go to your <a href="https://simplyprint.io/panel/user_settings/api">account settings</a> and create a new API key.</p>
|
| 572 | +<h2 id='method-2-oauth2-develop-integrations-for-simplyprint'>Method #2: OAuth2 - develop integrations for SimplyPrint</h2> |
| 573 | +<p>SimplyPrint supports OAuth2 logins for all users, regardless of their subscription, for approved integrations such as the <a href="https://simplyprint.io/integrations/cura">Cura slicer integration</a>.</p> |
| 574 | + |
| 575 | +<p>The OAuth2 method can be used to link a user's SimplyPrint account with a third party platform/software, and use the SimplyPrint API on behalf of the user.</p> |
| 576 | + |
| 577 | +<p>To obtain OAuth2 access, you must be added as an OAuth2 provider - contact us at <a href=" mailto:[email protected]" >[email protected]</a> to request access. </p> |
| 578 | + |
| 579 | +<p>The OAuth2 integration is quite new and not yet documented on this page - documentation will be sent on provider approval.</p> |
569 | 580 | <h2 id='the-base-url'>The base URL</h2>
|
570 | 581 | <p>The base URL for the SimplyPrint API is <code>https://api.simplyprint.io/{id}/</code>.</p>
|
571 | 582 |
|
|
0 commit comments