Collecting credentials for integration

Details you need to embed from the customer portal

In order to use the code with each of your "products," you will need to wire up the app, the client, and the APIs using data collected from the dashboard provided with Zentitle2.

On-premise and SDK-based applications

On-premise and SDK-based implementations use the Licensing API. The Licensing API doesn't use OAuth2 to authenticate requests. Instead, authentication is based on tenantId, productId, and entitlement Activation Code.

Then, you need "activation codes" for testing based on the product entitlements you will create.

Note there are two options on the API Credentials page, so ensure you pick the correct API details.

The details you will need to collect for your implementation are:

Tenant Id (API) - for authentication
zentitleApiUrl - API URL
Product Id - for identifying which product to license
Activation codes - to test (per the rights in the entitlement)

Tenant Id and API URL

Found under the Licensing API Details section, the TenantId, OAuth URL, and API URLs can be easily copied using the "copy" button on the left

The parameters are located under the "Account" > "API Credentials" on the left menu.

Example in code: .WithTenant("t_KRwhRp1yl0_9gsZjE5Yjqq") for SDK

Product Id

The Product Id is located under the "Configuration" > "Product" > "YourProduct" on the left menu.

First, click on the "Products" link in the left menu,

Then, choose the product you have added you wish to integrate.

Click the product name.

On the product page, in the details tab, you need the key "ID".

The Product ID can be easily copied using the "copy" button on the left.

Example in code: .WithProduct("prod_GROAP541F0qw2XzDQSOyrg")

Remember that each "product" has its own unique ID. You will need to use different IDs for every product you release.

Activation codes

The Activation codes are located under the "Entitlements" > "Activation codes" on the left menu.

This example assumes you have already created entitlements and added activation codes.

First, click the entitlement you will be testing.

Then, navigate to the activation codes tab on the entitlement page and find the activation codes in the "Activation Codes" section.

Test codes can be easily copied using the "copy" button on the left.

Testing

In the API docs, we also show how to setup Postman so you can test the API:

https://license.zentitle.io/docs#section/Postman-Configuration

Integrating with the SDK

Now you should have all the data required to set up the SDK and test it.

SaaS and API-based implementations

SaaS-type products use the Management API to manage entitlements.

Collecting the serverside parameters to input into the config file

SaaS-type products use the Management API to manage entitlements.

Zentitle2 Management API uses OAuth2 over HTTPS to manage authentication and authorization.

https://api.zentitle.io/docs/#section/Authentication

You will also need "activation codes" for testing based on the product entitlements you will create.

The details you will need to collect for your implementation are:

Tenant Id (API) - for authentication
oauth_url - OAuth URL
zentitleApiUrl - API URL
ProductID - unique code for the product being tested

Generate these:

client Id - your ID
clientSecret - secret key
Activation codes - to test (per the rights in the entitlement)

You will find most of these in the interface, but you must generate the API client and secret in API Credentials.

Tenant Id, OAuth URL, and API URLs

The TenantId is located under the "Account" > "API Credentials" on the left menu.

Found under the Management API Details section, the TenantId, OAuth URL, and API URLs can be easily copied using the "copy" button on the left.

API requires one more header to be set with Id of your Zentitle2 tenant, for example:
```
N-TenantId: t_OIRRKAYBA0CwKEsGjIJK6g
```

Client Id and clientSecret

The client Id and clientSecret need to be generated in the same section by clicking the "add API client" button in the right-hand part of the "Management API Clients" section.

Next, name the ClientID and save the name for the integration process.

Click save.

Clicking save generates the Client Secret key under the ID.

You can view the key by clicking the "eye" icon or copying it.

The "copy" button on the right can easily copy the secret key.

e.g. Twfx2Q5mH0izUXshrsTe3z3PIwkje22y

Before closing, make sure you copy and save the Client Secret for the integration process.