TAG LINE
TAG LINE
SMALL TITLE
BUTTON
Product Overview
Becoming familiar with the foundational concepts of LogiSense billing
Introduction
Product Vision
Usage Billing Challenges
LogiSense Billing UI Walkthrough
Terminology
Quick Start Guide
Release Notes
- LogiSense Billing 10.4.x Release Notes
- LogiSense Billing 10.5.x Release Notes
- LogiSense Billing 10.6.x Release Notes
- LogiSense Billing 10.7.x Release Notes
Accounts
Adding all of your customers and their products to the system
Account Overview Screen
Account Packages Screen
- Account Package Example
- Billing an Account Example
Account Settings Screen
Account Credits Screen
- Adding and Disbursing a Credit Example
Account Transactions Screen
- Adding a Transaction Example
Account Notes Screen
Account Contacts Screen
- Adding Account Contacts Example
Creating a New Account Screen
- New Account Creation Example
- Child Account Creation Example
Admin - Configuration
Configure all your system settings and user permissions
Owner Configuration Screen
- Financial Settings Example
- Password Policy Example
- Branding Example
- Automatic Naming Example
- Locales Example
- Payment Types Example
SMTP Settings Screen
- SMTP Example
Account Types Screen
- Account Types Example
Account Status Types Screen
- Account Status Types Example
Contact Types Screen
- Contact Types Example
Users and Roles
Users Screen
- User Example
Roles Screen
- Role Example
Role Groups Screen
- Role Group Example
Billing - Configuration
Group your customers into groups that bill in a similar fashion
Bill Runs Screen
- Bill Run Example
- Bill Run Auto-Pay Example
Bill Run History Screen
Bill Groups Screen
- Bill Group Example
General Ledger Codes Screen
- General Ledger (GL) Code Example
Contracts & Commitments
Ensure you are enforcing the contract commitments from your customers
Account Contracts Screen
- Commitments and Ramp Up Periods
- Early Termination
- Account Contract Example
Account Contract Status Types Screen
- Account Contract Status Types Example
Package Contracts Screen
- Package Contract Example
Customer Experience
Provide the best posssible experience from your billing touchpoints
Customer Portal
Email Templates
- Dunning/Payment Overdue Email Template Example
Dunning & Collections
Automate your collections and notification processes
Accounts Receivable Terms Screen
- Accounts Receivable Terms Example
Payment Terms Screen
- Payment Terms Example
Dunning Rules Screen
- Dunning Rules Example
Extensibility
Configure extra custom fields to cover unique scenarios
Custom Fields Screen
Custom Fields Layouts Screen
Importing & Exporting Data
Perform transforms on data that you wish to import into the system
Archiving Data
Data Imports
- Data Profiles
- Mapping
- Transforms
- Validations
- Debugging
Data Profiles Screen
Data Imports Screen
Invoicing & Credit Notes
Design your invoice templates and manage account invoices and credit notes
Account Invoices Screen
- Invoice Management Example
Account Credit Notes Screen
Invoice Delivery Screen
- Invoice Delivery Example
Invoice & Credit Notes Templates Screen
- Word Invoice Template Mail Merge Tips
- Embedding Reports in Invoice Templates
- Invoice Template Example
Rounding Behavior
Notifications & Events
Subscribe to different system events to trigger integration workflows
Available Events
Available Event Tokens
Notifications Screen
Payments
Record automatic payments or manually disburse amounts
Account Payment Methods Screen
Account Payments Screen
- Payments Example
Payment Gateway Screen
- Payment Gateway Example
Pricing
Explore different pricing options and customer specific catalogs
Account Price Plans Screen
Tiered Monthly Recurring Charge
Tiered Usage
Counting Rules for Tiered Pricing
Price Book Regions Screen
Price Books Screen
Product Catalog
Add all of our products and services to the product catalog
Services Screen
- Service Example
Service Status Screen
- Service Status Example
Service Transitions Screen
- Service Transitions Example
Service Types Screen
- Service Type Example
Packages Screen
- Recurring and One Time Charges Package Example
- Global Add-on Package Example
- Toll Free & Trunk Groups Products Use Case
Package Frequencies Screen
Package Status Screen
- Package Status Example
Counting Rules Screen
Promo Codes Screen
Regional & Currency Settings
Setup all of your regonal settings including multiple currencies
Configuring Countries
- Regional Settings Example
Configuring State/Province
Multi-Currency
Currency Exchange Screen
- Currency Exchange Example
Exchange History Screen
Reporting & Analytics
Dig into your billing data for the analytics you need
Charts & Dashboards
Generating, Viewing and Downloading Reports
Filtering, Generating and Downloading Reports Example
Revenue Recognition
Recognizing the monetary value of a transaction or contract over time
Revenue Recognition Configuration
IFRS 15 and ASC 606
Salesforce Integration
Connect LogiSense Billing to Salesforce to automate your quote-to-cash
Salesforce Admin Guide
- LogiSense Billing Configuration
- Salesforce (Pre App Installation Process)
- Salesforce (app installation)
- Connecting Salesforce to LogiSense Billing
- Account Field Mapping
- Package Field Mapping
- Contact Field Mapping
- Order Product Field Mapping
- Order Product Service Field Mapping
- Account Invoice List
- Importing and Syncing Data
- LogiSense Requests (API Logs)
Salesforce User Guide
Sales Orders
Combine multiple products into a single order for an account
Account Orders Screen
Share Plans
Configure share plans to share usage across multiple services
Account Share Plans Screen
Share Plans Screen
Share Plan Buckets Screen
Single Sign On
Single Sign On Configuration
Taxes
Manage your tax setup and integration with 3rd parties
Tax Codes Screen
Tax Vendor Screen
- LogiSense Tax Example
Tax Rates Screen
Service Tax Categories Screen
Account Tax Categories Screen
Usage & Rating
Create flexible usage pricing and transform event data
Usage Rate Groups Screen
Usage Rates Screen
Usage Rate Plans Screen
Usage Classes Screen
Usage Class Types Screen
GeoTree Screen
Rounding Rules
Time Periods Screen
Location Groups Screen
Mediation
Usage Data Feeds
Import Usage by API
Billing Activation Rules
Dynamic Usage Classes Screen
Usage Exceptions
- Exceptions Screen
- No UDR Usage Identifier match
- UDR time does not match time period of UDR Usage Identifier
- Usage Rate matching UDR not found
- Usage Rate Group matching UDR not found
- Usage Rate Plan not defined
- Final Usage Bill issued
- Software System Error
Use For Cost Configuration
Usage Buckets
Create definitions of usage inclusions that can be used in plans
Base Buckets Screen
Usage Buckets Screen
Developer
Information for those looking to integrate with the billing system
API Platform
Developers - Getting Started
- Tokens & Authentication
- PATCH, POST, PUT & DELETE
- Search Requests
- Deep Search - Related Objects
- v2/v3 GET Filters
- Update Requests
- Response Data
- LogiSense Tools
- API Logging
Developer - Data Views
- Creating a Database View
- Configuring your DataSource
Eventing System
- Events
- Notifications
Architecture
Explore the logical, delployment and functional architecture of LogiSense Billing
Logical Architecture
- Web Client
- Rating & Mediation Scaling
- Usage Aggregation and Scaling
- Billing Scaling
- Database
Deployment Architecture
- Overview
- Single Node
- Upgrade Strategy
Functional Architecture
- Module Descriptions
- Adjunct Rating & Charging
Security
Controlled Flexibility
Search

Tokens & Authentication

Last Updated: Tue Mar 14 2023

LogiSense APIs use JSON Web Tokens (JWT) for authentication. This article will explain how to obtain, use, and refresh a JWT. For more information about JWT read this.

Typical Workflow

  1. Client requests token from Authorization Server

  2. Client includes token in API requests to Resource Server

Requesting a Token

  • Token requests are made to the Authorization Server

  • Use the POST verb

  • Include request headers for Accept and Content-Type

  • Body includes username, password, grant_type, and client_id

Token Request Header

Definition

Accept

"Accept": "application/json"
Type: String
xhr.setRequestHeader('Accept', 'application/json')

Content-Type

"Content-Type": "application/x-www-form-urlencoded"
Type: String
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');

Token Request Parameter

Definition

username

"username": "myUsername"
Type: String
username= + myUsername + &password= + myPassword + &grant_type=password&client_id= + userClientId

password

"password": "myPassword"
Type: String
username= + myUsername + &password= + myPassword + &grant_type=password&client_id= + userClientId

grant_type

"grant_type": "password"
Type: String
username= + myUsername + &password= + myPassword + &grant_type=password&client_id= + userClientId

client_id

"client_id": "userClientId"
Type: String
username= + myUsername + &password= + myPassword + &grant_type=password&client_id= + userClientId

The resulting XHR code snippet (Note: use the proper version v6, v7 etc in your request path for the version of the API being used):

xhr.open("POST", "https://35.169.33.81/AuthorizationServer/api/v6/Access/Login", true);
xhr.setRequestHeader("Accept", "application/json")
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.send("username=" + userName + "&password=" + userPassword + "&grant_type=password&client_id=" + userClientId);

The response body will look similar to this:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTUxMiJ9.eyJvd25lcklkIjoiMSIsImFjdGluZ093bmVySWQiOiIxIiwidXNlcklkIjoiMTUzIiwicm9sZUlkIjoiMTIxIiwiaXNJbnRlcmFjdGl2ZSI6IkZhbHNlIiwidW5pcXVlX25hbWUiOiJhZG1pbiIsInN1YiI6ImFkbWluIiwiaXNzIjoiaHR0cDovL2F1dGhvcml6YXRpb25zZXJ2ZXIubG9naXNlbnNlLmNvbSIsImF1ZCI6IjA0NGI4YWQ2MDA2ODQ1YzI5NDQ2YjJmMThlNWI1OTA5IiwiZXhwIjoxNTMzOTExNjIwLCJuYmYiOjE1MzM4MjUyMjB9.WH2YffewqNq6bAZq9Gshuks4-RE_r85Qg545tvR-wSLqvDt5ftXw1irx-IFryRH1wWpn2KLWNhpXyl6WOsAaVw",
    "refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJyZWZyZXNoVG9rZW5HdWlkIjoiODI3ZjlhNzYyNzgzNDIyOWI2Nzc3OTZhOTZlYTkzMGEiLCJvd25lcklkIjoiMSIsImFjdGluZ093bmVySWQiOiIxIiwidXNlcklkIjoiMTAwMDAwMDAiLCJhdWQiOiIwNDRiOGFkNjAwNjg0NWMyOTQ0NmIyZjE4ZTViNTkwOSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJMb2dpc2Vuc2UgU3VwcG9ydCIsInN1YiI6IkxvZ2lzZW5zZSBTdXBwb3J0IiwianRpIjoiNmYwNzg5NDEtNGExMy00ZDllLWE3MGEtMTg5NWQ4NGM0ZTc3IiwiaWF0IjoxNjY3MzMyMTgxLCJuYmYiOjE2NjczMzIxODAsImV4cCI6MTY2NzMzMzk4MCwiaXNzIjoiaHR0cDovL2F1dGhvcml6YXRpb25zZXJ2ZXIubG9naXN",
    "token_type": "bearer",
    "expires_in": 1800,
    "audience": "044b8ad6006845c29446b2f18e5b5909",
    ".issued": "2022-11-01T19:49:41Z",
    ".expires": "2022-11-01T20:19:41Z",
    "actingOwnerId": 1
}

Token Response Property

Definition

access_token

"access_token": "A 512 character base64 string"
Type: String
This is the token you will include in your API requests

refresh_token

"refresh_token": "A 512 character base64 string"
Type: String
This is the token you will include in a request to refresh your access

token_type

"token_type": "bearer"
Type: String
When making API requests the Authorization header value will include 'Bearer' + the access token

expires_in

"expires_in": "1800"
Type: String
The time, in seconds, for which the token is valid (maximum value 1800 - 30 minutes)

refresh_token

"refresh_token": "587deb8616844c58b9991c61eebb2dfd"
Type: String
This value will be included when you want to refresh your token

audience

"audience": "044b8ad6006845c29446b2f18e5b5909"
Type: String
The intended recipient of the token.

.issued

".issued": "2022-11-01T19:49:41Z"
Type: String
Indicates when the token was issued by the Authorization Server. ISO 8601 format.

.expires

".expires": "2022-11-01T20:19:41Z"
Type: String
Indicates when the token expires. ISO 8601 format.

Using the Token

Let's use our newly acquired token to get all the accounts. We note the following differences between a token request and an API request:

  • API requests are made to the API/Resource Server

  • Use the appropriate verb

  • We still include request headers for Accept and Content-Type

  • We need to include the token in the Authorization request header

API Request Headers

Definition

Accept

"Accept": "application/json"
Type: String
xhr.setRequestHeader('Accept', 'application/json')

Content-Type

"Content-Type": "application/json"
Type: String
xhr.setRequestHeader('Content-Type', 'application/json');

Authorization

"Authorization": "Bearer + yourBase64token"
Type: String
xhr.setRequestHeader('Authorization', 'Bearer ' + yourBase64token);

The resulting JavaScript XHR code snippet:

xhr.open("GET", "https://35.169.33.81/ResourceServer/api/v6/Account", true);
xhr.setRequestHeader("Accept", "application/json")
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer " + yourBase64token);
xhr.send();

The Response

Response Body Property

Definition

trackingId

"trackingId": "06404d2e-5334-4283-9c79-057087f26822"
Type: String
Audit tracking number for the request

totalCount

"totalCount": 8
Type: Number
The number of items returned

items

"items": array
Type: Array
The resultant list of objects

Token Management

As noted when we received the access token, tokens do expire. Let's compare and contrast requesting and refreshing a token:

  • Do not send username or password in the refresh request

  • Include the refresh token received when the original token was issued

  • Token refresh requests are also made to the Authentication Server

  • They also use the POST verb

  • They also include request headers for Accept and Content-Type

  • The body still includes the client_id

  • A new value of refresh_token for grant_type

  • We need to include owner and user

Refresh Request Parameter

Definition

refresh_token

"refresh_token": A JWE or JWS in 'Compact Serialization Format'
Type: String
This value was received when requesting the original token and then subsequent refresh_token requests.

grant_type

"grant_type": "refresh_token"
Type: String
Use the value 'refresh_token' for refresh requests

client_id

"client_id": "044b8ad6006845c29446b2f18e5b5909"
Type: String
This will be the same as the initial token request.