The Ulifyi API works very easy. The Ulifyi API based on a Express JS Backend. So this means the API is a basic HTTPS/REST API for general operations. Every user get's a JWT (JSON Web Token) after the login. This JWT is main point for all API's of Ulifyi. The API need the token to find the user.
Ulifyi is using the API Version 1. The current API base URL is:
{% embed url="https://api.uli.fyi/api/v1" %}
| Version | Status | Default |
|---|---|---|
| 1 | Available (Beta) | Yes |
What is a UEID? A UEID is a Ulifyi Error ID, a short number that will tell the server what was the error.
| Error Code | Description |
|---|---|
|
|
| This error occurs when certain things are not specified like an API token or a UserId. Means this error means that no required information has been provided. | |
|
|
| This error occurs when an Auth token or API token is invalid. | |
|
|
| This error occurs when a request is sent where the information does not match the previous information. | |
|
|
| This error occurs when the specified ones are too short. | |
|
|
| This error occurs when the specified are too long. | |
|
|
| This error occurs when the specified data is not allowed. | |
|
|
| This error occurs when the specified are already in use like usernames. |
If you want to learn more how the Ulifyi API works then look at this page.
{% content-ref url="getting-started.md" %} getting-started.md {% endcontent-ref %}
Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:
{% content-ref url="broken-reference" %} Broken link {% endcontent-ref %}