Use the API

The API has been built with RESTful and HATEOS principles, allowing discovery of endpoints through navigating around the API graph using the returned Links. The API uses HTTP Verbs to invoke functionality, returning appropriate status codes depending on result.

Authentication

Authentication with the API is possible using the the following call:

POST https://taggloo.im/api/v4/login

(Use your server host instead of taggloo.im if targeting a different instance of Taggloo.)

with a JSON Payload in the Body:

{
    "UserName": "username",
    "Password": "password"
}

If successful, this will return an HTTP status 200 with a JSON response such as that below:

{
    "userName": "username",
    "token": "eyJhbGciOiJIxxxxxxpXVCJ9.eyJuYW1laWQiOiJhZxxxxxxxxDY5MDIxfQ.vHrfdBHGxxxxxMOG4EpKlQ"
}

The token is a JWT which must be sent within the HTTP Headers for API endpoints requiring authentication. Add the following HTTP Header to each call:

Authorization: Bearer <your-jwt-token>

Explore the API

You can use the Swagger interface to explore the API and functionality available. This can be accessed from the endpoint /api/index.html.