Authorization 101

The Zyllem API uses API keys to control the access rights of applications that connect to it.

To obtain authorization, generate at least one API keys on the web portal. Then, attach the API key as a query parameter named key to all your calls to the API.

🚧

TLS 1.2 is required

When connecting to Zyllem, you must use TLS 1.2 or later by default. Failure to do so will result in authentication issues.

Recommended reads:

• Preparing for TLS 1.2 in Microsoft Azure
• TLS Best practices with the .NET Framework

You may use the /ping resource to test your connectivity.

GET /api/ping?key=my-api-key HTTP/1.1
Host: yourEnterprise.zyllem.com
Content-Type: application/json

curl -X GET \
  'https://yourEnterprise.zyllem.com/api/ping?key=my-api-key' \
  -H 'content-type: application/json'

Ping

Use this resource to test the connectivity between your application and the Zyllem API. This simply returns a message addressed to your API client.

URL: GET https://{yourEnterprise}.zyllem.com/api/ping
Sample Response:

{
    "message": "Hello API Client"
}

{
    "message": "Invalid API key"
}

{
    "message": "The requested resource does not support http method 'POST'."
}

🚧

Authentication failed

If you get an authentication issue, make sure you are using TLS 1.2 or later by default. Recommended reads: Preparing for TLS 1.2 in Microsoft Azure and TLS Best Practices with .NET Framework