Get Partner App Details

When working with Payiano's APIs, it's important to authenticate each request using a unique set of API credentials linked to your partner account. This process starts with registering an App on your dashboard, which is necessary to obtain these credentials. Once your App is registered, it establishes a link between your operations and the Payiano API, enabling you to perform a variety of functions essential to your business. If you need to fetch details about the registered app or the permissions it has been granted, this endpoint is tailored for that purpose.

GET/app/whoami
Sandbox: https://api-partner.payiano.dev/v1/app/whoami
Live: https://api-partner.payiano.com/v1/app/whoami
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
Request
Request body schema:
application/json
Query parameters:
includes
Type: array_of_enums|null
Possible values:
[ "app.permissions_count", "app.permissions" ]

A list of additional app relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

Response
200
Response schema:
application/json
Response body:
app
Type: object

The app model details.

id
Type: ulid
Length: 26

The unique ID assigned to each app which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every app. This ULID is automatically created by our system and is used to uniquely identify and track each app in our database.

name
Type: string
Min: 2
Max: 255

This attribute represents the app's name. It's 'a crucial identifier for the app within the ecosystem. The name should be descriptive and concise, reflecting the app's purpose or functionality. It's essential to ensure that each app has a distinct name to avoid conflicts and confusion when used. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_].

key
Type: string

This attribute is a unique identifier for your application. When your app communicates with Payiano's APIs, the app key is often used to identify the app making the request. This key is typically public, meaning it's visible to both the app and the server it's communicating with, but it doesn't give away any sensitive information about your app. It's used in conjunction with the app secret for a more secure authentication process.

token
Type: string

This attribute is a confidential piece of information, akin to a password for your application. It is used to authenticate the identity of the application to the Payiano's API. This token should be kept private and secure, as it allows access to the API and other critical functions. If someone else obtains your app token, they could potentially misuse your application's identity to access sensitive data or resources.

is_active
Type: boolean
Default: true

This value indicates whether the app is active or not. This flag can be used to control the app's availability in runtime environments or listings without deleting or removing the app from records. A true value means the app is active and functioning, while a false value implies that the app is deactivated or not in use.

description
Type: string|null
Max: 10000

This field is for a textual description of the app. It can include information about the app's purpose, features, usage instructions, and any other relevant details. This description is valuable for administrative purposes and for providing other developers with an overview of what the app does.

permissions_count
Type: integer

This field shows the number of permissions granted to the app.

permissions
Type: array_of_objects

The assigned permission models to role.

name
Type: string

This attribute is the unique permission name. It is used to identify the exact access allowed for a partner employee or partner app. This means it helps in specifying what each employee or app can do or see within the partner's system.

is_app
Type: boolean

This attribute specifies the scope of the permission. When set to true, the permission can be assigned to both any app and any partner employee. If set to false, the permission is restricted and can only be only assigned to partner employees.

created_at
Type: datetime

The created datetime of the app. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

updated_at
Type: datetime

The updated datetime of the app. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

Response sample:
1
{ 2
 "app": { 3 "id": "01hqkasn015ewdjwtahjerw952", 4 "name": "Pyngy integration APP", 5 "key": "303168716b613033636e63686679736168777674336e636464335f30316871", 6 "token": "eyJpdiI6InMvZHlJTVNFbFROcVkyWDlLYWt0T2c9PSIsInZhbHVlIjoiL0V4Wno5MU1XZXdWWXdmODJUeXRlV0NtYjV2VEli", 7 "is_active": true, 8 "description": "This is the Shopify app.", 9 "permissions_count": 1, 10
 "permissions": [ 11
 { 12 "name": "cash_collection_transactions_view", 13 "is_app": true 14 } 15 ], 16 "created_at": "1722572118554", 17 "updated_at": "1722572118554" 18 } 19}