Authentication

Getting access to our endpoints and functionality

Last updated 07 Nov 2024

Before using any endpoint provided by Skrym you need to be able to authenticate your calls to our system. 🔐 Find out more below.

Users & Systems

In the Skrym ecosystem there are two different kinds of agents. These agents use different methods of authenticating themselves but have similar capabilities in what they can request. The different agents are:

Agent	Access through	Authenticates with
👩🏻‍💻 Users	https://scope.skrym.com	Username and password
🤖 Systems	https://api.skrym.com	Tokens

Obtaining access
Skrym is currently only available to select clients and partners. If your organization does not have access but you would like to try out Skrym, you can reach out to us.
We have an ambassador program for developers and professionals.

👩🏻‍💻 User

Through the initial onboarding with Skrym an organization will be set-up for you. Users are provided with a sign-up link to create an account for our dashboard and tool SCOPE. The account will then be tied to the users organization with the permissions for that user set by the organization.

There are two levels of SCOPE access Admin and Standard. SCOPE Admins can send invites to their organization.

🤖 System

Skrym uses Bearer Authentication for authenticating API-requests. This requires the user to provide a token with each request to the system.

After Skrym has setup an Scope account for you, you can find you token in the admin settings.

Warning
Keep your credentials secret! If your user or system credentials have been compromised please contact Skrym.

Using different products

The authentication provided by both systems for users also contain information regarding which products they have available at their disposal.

📦 Optimization
🌱 Emission calculation
🚚 Transport Management

If you find yourself wanting to use one of the APIs that you currently are not authorized to use, please contact your Skrym representative.

Authenticating an API-request

For the request to return a successful result you have to provide the provided token in the request header.

Setting the Authorization

Here are some examples of how you can set the authentication token in the header

curl


curl -X POST 'https://api.skrym.com/authentication.PingAuth' -H 'Authorization: Bearer <<YOUR BEARER TOKEN>>'

python

TypeScript


def Ping():
    URL = 'https://api.skrym.com/authentication.PingAuth'
    headers = {"Authorization" : "Bearer <<YOUR BEARER TOKEN>>"}
    response = requests.post(URL, headers = headers)
    if response.status_code == 200:
        print("Successfully authenticated request")
    else:
        print("Request failed")