Cencora Financial Services API Documentation

Description

Cencora Financial Services (CFS) platform uses OAuth 2.0 standard protocol to grant access to the CFS protected services / resources without necessarily revealing client's long term credentials for every requests. For additional support on implementing OAuth 2.0 Authorization framework, please refer OAuth 2.0 .

Parameters

Y = Required, Y* = Conditional, X = Required when block is present and N = Optional

All * marked Parameters are Case-sensitive, required and null values are NOT accepted.

CFS offers two types of Authorization Mechanisms based on the grant_type

Authorization Mechanism 1

grant_type*

Set this to "password"

username*

-[string(32)]--API UserName, Shared by CFS as part of Initial Business Setup.

password*

-[string(32)]--API Password, Shared by CFS as part of Initial Business Setup.

ProgramID*

-[string(6)]--Unique Identity for CFS programs. This will be Shared by CFS as part of Initial Business Setup.

Authorization Mechanism 2

grant_type*

Set this to "client_credentials"

client_id*

-[string(32)]--API UserName, Shared by CFS as part of Initial Business Setup.

client_secret*

-[string(32)]--API Password, Shared by CFS as part of Initial Business Setup.

ProgramID*

-[string(6)]--Unique Identity for CFS programs. This will be Shared by CFS as part of Initial Business Setup

Return Values

MessageResponse

Property	Description	Required	Type
access_token	The access token string as issued by the authorization server.	Y	string
token_type	The type of token this is, typically just the string “Bearer”.	Y	string
expires_in	The duration of time the access token is granted for.	Y	Integer
userName	API UserName for which token has been created.	Y	string, 32
.issued	The Timestamp of the token issued by Authorization server in UTC	Y	DateTime
.expires	The expiration Timestamp of the issued token in UTC	Y	DateTime

Method: POST

Url: This will be shared by CFS as part of Initial Business Setup

Request:

Authorization : Password Flow

curl --location '{AuthorizationTokenURL}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username={apiusername}' \
--data-urlencode 'password={apipassword}' \
--data-urlencode 'ProgramID={cfsprogramid}'

Authorization : Client Credentials Flow

curl --location '{AuthorizationTokenURL}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={apiusername}' \
--data-urlencode 'client_secret={apipassword}' \
--data-urlencode 'ProgramID={cfsprogramid}'

Response:

{
  "access_token": {},
  "token_type": {},
  "expires_in": {},
  "userName": {},
  ".issued": {},
  ".expires": {}
}

User Authorization API