# API API

> API API on Apizie: 27 endpoints (Add new article, update existing article, Delete article from the system, Add article details that associate with a Gym, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:tl-api-azurewebsites`
- Category: Open Data
- Status: byok
- Source: https://unicorn-solutions.com
- Page: https://zieapi.vercel.app/api/open-data/tl-api-azurewebsites
- OpenAPI: https://zieapi.vercel.app/api/open-data/tl-api-azurewebsites/openapi.json

Web API for TL mobile and web app

## Endpoints

### Add new article
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### update existing article
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete article from the system
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ArticleId | integer | no | indentity number(primary key) for article object |

### Add article details that associate with a Gym
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-update-article-gym-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### GET /api/Article/GetAddons
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-get-addons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| searchText | string | no | Search text - will be search by the name |
| gymIds | string | no | Comma separated gymIds deafult "-1" for all gyms |
| type | string | no |  |
| limit | integer | no |  |
| offset | integer | no |  |

### Get Gym specific properties for article
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-gym-article-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| articleId | integer | yes | indentity number(primary key) for article object |
| gymId | integer | yes | indentity number(primary key) for gym object |

### Add measure unit
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-add-measure-unit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get mesure units
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-get-measure-units` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | type of the measure unit (all, item, service) |

### Get Revenue Accounts
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-get-revenue-accounts` (byok)

### Search articles It will only return basic information of article
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| searchText | string | no | part of article name |
| gymId | integer | no | -1 for all gyms |
| type | string | no | filter article type. default is 'all' |
| orderBy | string | no | order by column.!-- invalid column will give internal server error |
| limit | integer | no | number of recode in result and default is 100. use negative numbers to order by desc |
| offset | integer | no | number of recodes to skip |
| activeStatus | integer | no | Active Status 1 : Active, 2: Inactive, 3: All, Default : 1 |

### Deactivate existing article
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ArticleId | integer | no |  |
| status | integer | no | 1 : activate , 2 deactivate |
| userName | string | no | Updating user |

### Get article details This will return all properties related to article entity
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| articleID | integer | yes | indentity number (primary key) for article object |

### Authenticate and provide token for autherizations.
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/auth-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get gym details This will return all properties related to gym entity
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/gym-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gymID | integer | yes | indentity number (primary key) for gym object |

### Get all of the members details This will return all properties related to member entity
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/membership-get` (byok)

### Add new Member
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/membership-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get package details by packageId
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| packageId | integer | no | primary key of package entity |

### Insert new package into the system
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update existing package by its ID
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete existing package
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PackageId | integer | no | primary key of package entity |

### Search packages
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| searchText | string | no | part of package name |
| gymId | integer | no | primary key of TL gym entity |
| type | string | no | filter package type.!-- default is 'all' |
| orderBy | string | no | order by column.!-- invalid column will give internal server error |
| limit | integer | no | number of recode in result and default is 100. use negative numbers to order by desc |
| offset | integer | no | number of recodes to skip |
| activeStatus | integer | no | active status active : 1, inactive : 2, all 3, deafult : 1 |
| categoryId | integer | no | Packge Category Id |
| startpPrice | number | no | Start price of the price Range |
| endPrice | number | no | End Price of the price Range |
| requestSource | integer | no | 1 : MRM, 2 : Mobile |

### Status update of existing package
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/package-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| packageId | integer | no | package Id |
| status | integer | no | status : 1 activate, 2 : deactivate |
| userName | string | no | Status updated User |

### Get the current status of message
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/status-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| messageId | string | no | respose of POST request |

### Get the all Test objects.
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/test-get` (byok)

### Get all Users detail This will return all properties related to User entity
`GET https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/user-get` (byok)

### Register a new User
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/user-register-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | integer | no | Indentity number(primary key) for user object. Generated in DB table when inserting a record. |
| AccountNumber | string | no | Account number of the user.It can be any stakeholder of the application.even can be a gym. |
| GymNumber | string | no | If this user is a gym, then the gym number. |
| ExternalEntityNumber | string | no | Entity number that make a relationship with BOX API DB. |
| Name | string | no | Name of the user. |
| Number | string | no | Unique number maintain by application to idenify user. |
| IntroduceBy | integer | no | If Someone introduced this user to the system, then that user's UserId. |
| Guardian | integer | no | Gaurdian of the this user if he/she is under 18 years old. |
| TypeId | integer | no | Type of the user. |

### Update an exsisting User
`POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/user-update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | integer | no | Indentity number(primary key) for user object. Generated in DB table when inserting a record. |
| AccountNumber | string | no | Account number of the user.It can be any stakeholder of the application.even can be a gym. |
| GymNumber | string | no | If this user is a gym, then the gym number. |
| ExternalEntityNumber | string | no | Entity number that make a relationship with BOX API DB. |
| Name | string | no | Name of the user. |
| Number | string | no | Unique number maintain by application to idenify user. |
| IntroduceBy | integer | no | If Someone introduced this user to the system, then that user's UserId. |
| Guardian | integer | no | Gaurdian of the this user if he/she is under 18 years old. |
| TypeId | integer | no | Type of the user. |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-post" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/open-data:tl-api-azurewebsites/article-post with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. API itself also needs your own key from tl-api.azurewebsites.net.

### Can AI agents use the API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:tl-api-azurewebsites.

### What is the status of the API API?
Needs your own provider key (bring your own key)