API Updates (On Friday July 12th)

[deviint]

Hello hello. There's a few updates coming to the OF API this week.

I'm slowly restructuring the API / website to be a bit more organized. With that includes a landing page, dedicated docs page, and eventually more features getting added on.

There's no good way to release updates without it affecting users in the current setup, but for future updates API versioning will be implemented.

Upcoming breaking changes:

• API base path is changing (ofapi.xyz/api -> api.ofapi.xyz)
• Status endpoint removal
• Moving to a subscription model
• API response changes

API base path change
As more things get added to the API, it makes sense to put all API stuff in one place. Changing the base path allows that to happen.

Status endpoint removal
This is happening because the endpoint is redundant, and its main goal is to provide a look at what version the API rules are. Instead, the status of the rules can be found on the upcoming landing page along with other stats.
And then for subscribing to rules updates, there's the option of registering a webhook.

Moving to a subscription model
Tokens weren't ideal for anyone, I've received more complaints about the token system than anything else. So instead, a subscription model allows me to offer unlimited requests, added features, and provide additional support for power users.

API response changes
GET /rules

The is_current and new_balance fields will be removed in the future.
This endpoint will fail if the rules are not current, so the is_current field is always true.
new_balance will be replaced with requests_left, as tokens are being phased out.

Best,
deviint