.. getting-started.rst


.. _getting-started-label:

===============
Getting Started
===============


Welcome to YubiEnterprise Subscription & Delivery Services! This section provides an introduction to supporting documentation for common tasks performed by different user categories when working with the YubiEnterprise Console and the YubiEnterprise Delivery API. 

.. Note:: What you can do in the Console depends on your role and permissions. The descriptions below are specific to each user category. For more information, see :ref:`user-permissions-label`.

Customers
=========

**Organization owner with CONSOLE OWNER role**
  You are an account owner purchasing keys for your organization. You want to get your first set of keys, add Console users from your organization, and manage their account permissions. 
  
  **Understanding purchasing and delivery**

    * :ref:`Subscriptions and key models <subscr-label>`

    * :ref:`Shipping costs and taxes <shipping-costs-label>`

    * :ref:`Destinations, delivery types, and quantities <key-quantity-label>` 
  
  **Onboarding and accessing the Console**

    * :ref:`Onboarding procedure <onboarding-label>`

    * :ref:`Viewing initial purchase <procedure-label>`

    * :ref:`Requesting initial shipping of (up to 10) keys <shipping-single-label>` 

  **Managing your Console users**

    * :ref:`Adding users and permissions <add-users-label>`
  
    * :ref:`Recovering accounts <account-reset-label>`

**Organization IT administrator with CONSOLE ADMIN role**
  You manage deployment of keys for your organization. You want to see the inventory, understand how many keys are available, and ship keys to various parts of your organization.
  
  **Monitoring your inventory**

    * :ref:`Checking available inventory <dashboard-customer-view-label>`

    * :ref:`Viewing purchase orders <purchase-orders-label>`
  
  **Managing shipment of keys**

    *  :ref:`Getting an overview of shipments <shipments-label>`

    *  :ref:`Requesting shipment to a single address <shipping-single-label>`
  
    *  :ref:`Requesting shipment to multiple addresses <shipping-multiple-label>`

    *  :ref:`Correcting shipment addresses <incompletes-label>`

    *  :ref:`Editing and deleting shipments <editing-shipment-label>`

    *  :ref:`Managing refunds for failed shipments  <refunds-label>`


**Organization auditor with CONSOLE AUDITOR role**
  You are an auditor for an organization and want to review data like purchase orders, shipments and permission settings. You also want to download information for reporting purposes.
  
  **Viewing data for an organization**

    * :ref:`Purchase orders <purchase-orders-label>`

    * :ref:`Shipment requests <shipments-label>`

    * :ref:`Processed refunds <refunds-label>`

    * :ref:`Users and their permissions <viewing-users-label>`
  
  **Downloading information**

    * :ref:`Shipment requests <shipments-csv-label>`

    * :ref:`Processed refunds <download-refund-csv>`


Distributors
============

**User with DISTRIBUTOR VIEW access**
  Distributors are organizations that sell Yubico products to associated resellers that in turn sell the products to end customers. As a distributor you want to see what was sold by your resellers, monitor customer inventories, and provide your resellers with access to view purchase orders.
  
  **Getting an overview**

    * :ref:`Reseller and customer overview <distributor-view-label>`

    * :ref:`Viewing inventory for a reseller's customer <distributor-inventory-view-label>`
  
  
  **Viewing purchase orders**

    * :ref:`Checking what was sold per reseller and customer <distributor-view-label>` 
  
    * :ref:`Viewing purchase order details <purchase-order-popup-label>` 

    * :ref:`Checking if a customer can use automated delivery (YE Delivery) <po-dist-column-headings>` 

  **Managing view permissions**

    * :ref:`Allowing resellers to view purchase orders <dist-manage-settings-label>` 

Resellers
=========

**User with RESELLER VIEW access**
  Resellers are organizations that sell Yubico products to end customers. As a reseller you want to see what was sold to your customers, monitor their inventories, and provide access for customers to view purchase orders.
  
  **Getting an overview**

    * :ref:`Customer overview <reseller-view-label>` 

    * :ref:`Viewing inventory for a customer <reseller-inventory-view-label>` 
  
  **Viewing purchase orders**

    * :ref:`Checking what was sold for a customer <reseller-view-label>`
  
    * :ref:`Viewing purchase order details <purchase-order-popup-label>`  
  
    * :ref:`Checking if a customer can use automated delivery (YE Delivery) <po-resell-column-headings>` 

  **Managing view permissions**

    * :ref:`Allowing customers to view purchase orders <resell-manage-settings-label>` 

Integrators
===========

**Developer with CONSOLE ADMIN role**
  You are a developer integrating the YubiEnterprise Delivery API into a system on behalf of a customer organization. You want to understand how to get started with the YubiEnterprise Delivery API, and how to use it for example to create shipment requests.
  
  **Getting started with the YubiEnterprise Delivery API**

    * :ref:`API Onboarding Playbook <api-onboarding-pb-label>`

    * :ref:`Setting up an API caller with access token <api-caller-token-setup>` 
  
  **Working with the YubiEnterprise Delivery API**
  
    * :ref:`API best practices <best-practices-label>` 
    
    * :ref:`Requesting shipments <api-shipment-request>` 
  
    * :ref:`Listing, tracking, and searching shipment requests <api-tracking-label>`
  
    * :ref:`Shipment status <shipment-status-label>` 

    * :ref:`Managing API tokens <lifecycle-label>` 

  **Integration examples**

    * :ref:`Integrating with ServiceNow <servicenow-label>`


-------------------------------------

To file a support ticket for YubiEnterprise Delivery, click `Support <https://www.yubico.com/products/yubienterprise-subscription/contact-support/?selectForm=I+need+help+with+YubiEnterprise+Delivery>`_.