Operator APIs | Data Ingestion

Data Ingestion API Authentication

Data Ingestion is a product that allows NetRefer clients to use REST principles to ingest data into the PMP.

It is possible to ingest data in real-time sending a single event or in batch.

To access the APIs, clients should have an appropriate account registered with NetRefer.

This account provides access to specific NetRefer products, which in our case is API.

Also, clients must provide a Subscription Key allowing access to Data Ingestion APIs.

The authentication flow is depicted conceptually in the diagram below.

Using Active Directory to request a JWT

OAuth 2.0 is used to get access to the Data Ingestion API.

To authenticate within NetRefer and to call the Data Ingestion API, developers must request JWT, providing the following parameters:

• Grant type: password

• Client ID: will be provided to the client while onboarding to Data Ingestion. Example of id is: 5a324196-7727-45fd-8ac3-1436cd541d76

• Access Token URL: https://login.microsoftonline.com/0e0b50ac-5253-4347-b528-251b2f17cfc6/oauth2/v2.0/token

• Client Secret: will be provided to the client while onboarding to Data Ingestion

• Username: will be provided to the client while onboarding to Data Ingestion

• Password: will be provided to the client while onboarding to Data Ingestion

• Scope: api://5a324196-7727-45fd-8ac3-1436cd541d76/Events.Injestion

Once all the requirements are met, execute an HTTP POST call to "Access Token URL" to get the JWT.

In the API request, you have to add an "Authorization" header with the value:

• Bearer JWT-value-from-NetRefer-Data Ingestion

An example of a request using different languages can be found on the APIs page of this portal.

Authorization to use Data Ingestion product

To authenticate access to the Data Ingestion product, HTTP requests must include an additional header:

• Ocp-Apim-Subscription-Key: will be provided to the client during onboarding to Data Ingestion. Example: baea25a9f0fe4687845575c07e539a9e9

A full example of the Data Ingestion API call is illustrated in the diagram below.