|
| 1 | +{{#> layout title="REST API reference" active_api_resources=true }} |
| 2 | + <div class="container"> |
| 3 | + <div class="row"> |
| 4 | + <div class="col-xs-12"> |
| 5 | + <h1 class="rest">REST API reference cheat sheet</h1> |
| 6 | + </div> |
| 7 | + <div class="col-xs-12 col-sm-9"> |
| 8 | + <p><em>All our available endpoints. Just for you.</em></p> |
| 9 | + </div> |
| 10 | + </div> |
| 11 | + <div class="row rest"> |
| 12 | + <div id="navbar" class="col-sm-3 hidden-xs"> |
| 13 | + <nav role="tablist" data-spy="affix" data-offset-top="80"> |
| 14 | + <ul class="nav nav-stacked"> |
| 15 | + <p class="pre-nav rest"> <img class="pull-left" style="margin-right: 5px; height: 27px;" src="/img/icons/icon--rest.svg"> REST API endpoints</p> |
| 16 | + {{#each categories as |category categoryId|}} |
| 17 | + <li class="main-nav"> |
| 18 | + <a href="#{{{categoryId}}}">{{{categoryName}}}{{#if categoryDeprecated}}<em> - Deprecated</em>{{/if}}</a> |
| 19 | + <ul class="nav"> |
| 20 | + {{#each category.resources as |resource resourceId|}} |
| 21 | + <li class="sub-nav"> |
| 22 | + <a href="#{{{resourceId}}}">{{{resourceName}}}</a> |
| 23 | + </li> |
| 24 | + {{/each}} |
| 25 | + </ul> |
| 26 | + </li> |
| 27 | + {{/each}} |
| 28 | + </ul> |
| 29 | + </nav> |
| 30 | + </div> |
| 31 | + <div class="col-sm-9"> |
| 32 | + {{#each categories as |category categoryId|}} |
| 33 | + <a class="anchor" id="{{{categoryId}}}"></a> |
| 34 | + <h2>{{{categoryName}}}{{#if categoryDeprecated}}<em> - Deprecated</em>{{/if}}</h2> |
| 35 | + {{#each category.resources as |resource resourceId|}} |
| 36 | + <a class="anchor" id="{{{resourceId}}}"></a> |
| 37 | + <h3 class="picto"> |
| 38 | + <img src="img/illustrations/illus--{{{resourceId}}}.svg"/> |
| 39 | + {{{resourceName}}}{{#if ../categoryDeprecated}}<em> - Deprecated</em>{{/if}} |
| 40 | + </h3> |
| 41 | + {{#if isProductIdentifierOrUUID}} |
| 42 | + <a class="anchor" id="{{{categoryId}}}"></a> |
| 43 | + <div class="alert alert-warning"> |
| 44 | + <p>This API provides two endpoints for interacting with products:</p> |
| 45 | + <ul> |
| 46 | + <li><b><a href="/api-reference-saas-index.html#Productuuid">Product (UUID):</a></b> We strongly recommend using this endpoint for its reliability and flexibility. UUIDs, or Universally Unique Identifiers, are guaranteed to be unique and never change, even if other product identifiers like SKUs are modified. This ensures consistent product identification regardless of future changes. Additionally, UUIDs allow interaction with products that lack a traditional identifier.</li> |
| 47 | + <li><b><a href="/api-reference-saas-index.html#Productidentifier">Product (Identifier):</a></b> This endpoint is useful when you already have a product identifier within your systems. This identifier, which could be a SKU or internal code, can be used to directly interact with the corresponding product in our API. This simplifies integration for workflows that rely on existing product identification methods.</li> |
| 48 | + </ul> |
| 49 | + </div> |
| 50 | + {{/if}} |
| 51 | + <div class="list-group"> |
| 52 | + {{#each resource.operations as |operation operationId|}} |
| 53 | + <a class="list-group-item" href="{{../../../htmlReferencefileName}}.html#{{{operationId}}}"> |
| 54 | + <div class="row"> |
| 55 | + <div class="col-xs-12"> |
| 56 | + <p class="list-group-item-heading">{{{summary}}}</p> |
| 57 | + </div> |
| 58 | + </div> |
| 59 | + <div class="row"> |
| 60 | + <div class="col-xs-12"> |
| 61 | + <p class="list-group-item-text"> |
| 62 | + <span class="label label-verb label-{{{verb}}}">{{{verb}}}</span> |
| 63 | + <span class="text-api-url">{{{path}}}</span> |
| 64 | + </p> |
| 65 | + </div> |
| 66 | + </div> |
| 67 | + </a> |
| 68 | + {{/each}} |
| 69 | + </div> |
| 70 | + {{/each}} |
| 71 | + {{/each}} |
| 72 | + </div> |
| 73 | + </div> |
| 74 | + {{> back-to-top-button}} |
| 75 | + </div> |
| 76 | +{{/layout}} |
0 commit comments