API

Current session request

A RamBase session is created after a successful login to the RamBase API. The session holds a lot of information and some of the information can be retrieved through the current session request:

GET https://api.rambase.net/system/sessions/current

The following is returned:

  • RanBase name
    The RamBase system the user is authenticated against.
  • User identifier (PID)
    The user identifier the authenticated user has in specific RamBase system.
  • Customer/supplier identifier
    The customer/supplier the user is making requests on behalf. Typically set when user is authenticated against a portal API client, like the supplier portal.
  • Database / company
    The database / company the user is using when the $db query parameter is not specified.
  • API client identifier
    The API client identifier used in the authentication.
  • ID verification token
    A token to be used for verifying user in third party systems. Read more about id verification token here.

Here is an example response:

1
{
2
    'session': {
3
        'pid': 666,
4
        'customerId': null,
5
        'supplierId': null,
6
        'database': 'JHC-NO',
7
        'ramBaseName': 'HATTELAND',
8
        'apiClientId': 'xcH1zRJAg0-abcdefghijklm',
9
        'idVerificationToken': 'q6SD0ZhQ0k6DO9-abcdefghijklm'
10
    }
11
}