Authentication

How to gain access each resources on the API

There is currently one way to authenticate through Berymo Schedule API v1: authentication key and secret. A key can be created by Berymo support team. Token also has pair called secret.

First you need to have API KEY and API SECRET that are provided by Berymo. If you do not have those credentials, please get in touch with us. [email protected]

API KEY and API SECRET should be sent as header parameters. Unless you provide these keys, you are not able to authenticate API endpoints.

Header keys should be sent like the below:

X-AUTH-APIKEY

X-AUTH-APISECRET

API Host

https://api.berymo.com/api/v1

Example API Call through curl library:

curl -H "X-AUTH-APIKEY: [YOUR_API_KEY]" -H "X-AUTH-APISECRET: [YOUR_API_SECRET]" https://api.berymo.com

If your API KEY is wrong, you get the error message below:

{
    "error": {
        "code": 403,
        "message": "Username could not be found."
    }
}

If your API SECRET is wrong, you get the error message below:

{
    "error": {
        "code": 403,
        "message": "Invalid credentials."
    }
}

Errors

Berymo uses conventional HTTP response codes to indicate the success or failure of an API request.

As a general rule:

• Codes in the 2xx range indicate success

• Codes in the 4xx range indicate incorrect or incomplete parameters (e.g., a required parameter was omitted, an operation failed with a 3rd party, etc.)

• Codes in the 5xx range indicate an error with Berymo's servers (these are rare)

Berymo also outputs an error message and an error code formatted in JSON:

{
    "error": {
        "code": 404,
        "message": "Page not found in this space"
    }
}