API Credential Check

bi...@shelleyconsulting.com

unread,

Mar 4, 2020, 10:56:59 AM3/4/20

to TramsAPI Beta

Hi Dan,

Is there a way to check the expiration date of the API license before or when logging in?

Dan Palley

unread,

Mar 4, 2020, 2:16:20 PM3/4/20

to TramsAPI Beta

Hi Bill,

Unfortunately, there's no way to check before logging in. After logging in, you can verify that you're seeing the expected capabilities in the response.

{
"apiVersion": "4.09",
"result": {
"resultcode": 0,
"resulttext": "",
"SessionID": "{3DA91D57-7467-4513-BA19-4023F63E0A86}",
"APICapabilities": [
"Query",
"Load",
"InsertUpdateDelete",
"EncryptedAccess",
"AdHocQuery"
]
}
}

if APICapabilities is empty, then there was a problem with the access key provided.

{
"apiVersion": "4.09",
"result": {
"resultcode": 0,
"resulttext": "",
"SessionID": "{B3B3289F-303D-41A2-819B-E46D9C00927A}",
"APICapabilities": []
}
}

Dan

paulob

unread,

Mar 4, 2020, 3:49:15 PM3/4/20

to TramsAPI Beta

Hi Dan,

which API Credentials are these? What I am missing here?

How can I check if I have them or not?

sorry - I'm lost again

thanks

Dan Palley

unread,

Mar 4, 2020, 8:30:48 PM3/4/20

to TramsAPI Beta

Hi Paulo,

API capabilities are determined by the Access Key you specify during the login process. You should have received an access key for your database when you signed up for the API. If you don't specify an access key, you get a limited set of capabilities.

Dan

paulob

unread,

Mar 5, 2020, 4:54:45 PM3/5/20

to TramsAPI Beta

Thank you.

I don't think I have an access key (how do I get one?) . We have used so far to create groups (I know not supported, etc) but it has been a huge help. We are just in the process of using for other things such as loading payments/invoices, profiles, and eventually create invoices...

Version: 4.07.00.041

here is what I am getting back:

{
    "apiVersion": "4.07",

    "result": {
        "resultcode": 0,
        "resulttext": "",

        "SessionID": "{1400DBB0-2BFA-493B-8D40-DBD533B32027}",
        "APICapabilities": []
    }
}

BTW, is there a way that we could search by Group Name ? params is not showing this option... thanks
/group/getparams
 "params": {
            "includeCols": {
                "type": "string"
            },
            "excludeCols": {
                "type": "string"
            },
            "forceRefresh": {
                "type": "boolean"
            },
            "logView": {
                "type": "boolean"
            },
            "RecNo": {
                "type": "largeInt"
            }

Dan Palley

unread,

Mar 5, 2020, 9:21:12 PM3/5/20

to TramsAPI Beta

Hi Paulo,

You're using a fairly old version of TramsAppServer (4.07). We just released 4.09 yesterday. Please upgrade so you stay current.

You'll need an access key to create/update invoices, payments, profiles, res cards and activities. Contact Linda Pannekeet and she should be able to provide you with one.

We don't have a group search feature. You can pull the entire list and search on your end.