[Internal] - How to set up API Subscriptions

Introduction:

In this article, we will provide a simple step by step guide on how to set up a customer to integrate via ShipServ API and assign API subscriptions.

Pre-requisites:

For any customer to integrate with ShipServ, they should have the following:

1. A ShipServ Tenant with Trade subscription. If its an existing customer, then go to step 2.

2. Create a User account that would be use for integration purpose only.

   Note: For production accounts, it is recommended to have a dedicated email address for API connections, not linked an employee.

3. Generate a Client id and Client secret by going to the tenant admin account > Integrations & Workflow > Tenant authorizations > Click on Generate tenant authorization. See below pic for reference.

   

4. Assign the Api Subscription. ShipServ offers customers different API's to integrate.

   Note: Any subscription requests for customers should be approved by the AM/Tech AM's.

   
   Here's the list of subscriptions available for our customers. The can choose one or more subscriptions.

   1. Order Management:

       

      What can customers do? - ShipServ's Order management APIs give Buyers and Suppliers a simple and secure way to connect and integrate the flow of trading documents from Requisitions to Purchase Order Confirmations.

      
      How to assign a subscription? - Go to the tenant admin account > click on Subscriptions > click on Create new Subscription > search for Order Management API > Select Order Management API. See below pic for reference.

      

      What information to provide to customers? - Once you assign the subscription, provide the customer with the following kit:

      1. Client id

      2. Client secret

      3. User name - the registered user email address.

      4. Password - usually set by the customer. They should have this information.

      5. Link to the developer portal.

      Note: If the customer has any one of the API subscriptions, they can use the same client id, secret and user credentials to connect to the order management API.
      
      

   2. Control Tower API:

       

      What can customers do? - ShipServ's Control Tower API gives Buyers and Suppliers a simple way to get real time status updates on your documents with advance filtering options, directly to your system or incorporate the data in your reporting tools.
      
      

      How to assign a subscription? - Go to the tenant admin account > click on Subscriptions > click on Create new Subscription > search for Order Management API > Select the Control Tower Subscription. See below pic for reference.

      

      Note: There are 2 control tower APIs, one for Order Management and one for Invoicing. If not specified, please clarify with the AM or Automation team.

      What information to provide to customers? - Once you assign the subscription, provide the customer with the following kit:

      1. Client id

      2. Client secret

      3. User name - the registered user email address.

      4. Password - usually set by the customer. They should have this information.

      5. Link to the developer portal.

      Note: If the customer has any one of the API subscriptions, they can use the same client id, secret and user credentials to connect to the control tower API.
      
      

   3. Invoicing API:

      
      What can customers do? - The Invoicing API’s will allow Suppliers to POST Invoices and Credit-Notes along with their supporting documents from your invoicing system and will allow the Buyers to import the Invoices and Credit-Notes along with the supporting documents, directly into your ERP systems.
      
      How to assign a subscription? - Go to the tenant admin account > click on Subscriptions > click on Create new Subscription > search for Order Management API > Select e-invoicing. See below pic for reference.

      

       

      What information to provide to customers? - Once you assign the subscription, provide the customer with the following kit:

      1. Client id

      2. Client secret

      3. User name - the registered user email address.

      4. Password - usually set by the customer. They should have this information.

      5. Link to the developer portal.

      Note: If the customer has any one of the API subscriptions, they can use the same client id, secret and user credentials to connect to the invoicing API.