WeFitter challenge API
WeFitter API’s challenge engine will bring endless engagement to your platform.For more information about the possibilities in challenges please go to https://www.wefitter.com/en-us/features/gamification/Challenges have multilanguage support on the fields: `Title`, `Slogan`, and `Description`.By default, challenges get the default-language that is configured in the app. Whenever a challenge is requested through the API this challenge will be presented in the default language.If another language is preferred, this can be requested by adding the header parameter `Accept-Language` stating the language short code (ex. `en` for english). If this language short code is not present in the title of the challenge, the default language will be returned.These translation fields contain JSON strings, for example:```{"en":"this is the English title","nl":"this is the Dutch title"}```So to create a multilanguage challenge, please provide the title, slogan, and description field as json strings, be aware that because of serialization this should be formed with backward slashes: {"title": "{\"en\":\"this is the English title\", \"nl\":\"this is the dutch title\"}","slogan": "{\"en\":\"this is the English title\", \"nl\":\"this is the dutch slogan\"}","description": "{\"en\":\"this is the English title\", \"nl\":\"this is the dutch description\"}",}
WeFitter challenge API is one of 9 APIs that WeFitter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include challenge. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 22 operations across 12 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version v1.3.
Requests are made against the base URL https://api.wefitter.com/api/v1.3.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
WeFitter challenge API declares
3 security schemes
for authenticating requests.
It defines a basic scheme (Basic).
An API key is passed in the header as Authorization (BearerProfile).
An API key is passed in the header as Authorization (BearerAdmin).
By default, every request must be authenticated.
Basic— Basic Authentication is used to create administrator bearer tokens. Once a bearer token has been made, remove this auth. ('logout' in Swagger')BearerProfile— Bearer authentication for logged-in profiles. When using the GUI, please don't forget to prefix your bearer tokens with the text 'bearer', followed by a space.BearerAdmin— Bearer authentication for administrators. When using the GUI, please don't forget to prefix your bearer tokens with the text 'bearer', followed by a space.
Paths & Operations 22
Across 12 paths, the API surfaces 22 operations — 2 DELETE, 8 GET, 1 PATCH, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
WeFitter API’s challenge engine will bring endless engagement to your platform. For more information about the possibilities in challenges please go to https://www.wefitter.com/en…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ChallengeDetail (29 properties), ChallengeList (20 properties), LeaderboardProfile (9 properties), LeaderboardTeam (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WeFitter 8
Other APIs WeFitter publishes across the network.