Skip to content

API Documentation

Mateusz Donhefner edited this page Jan 18, 2021 · 19 revisions

API Documentation

Table of Contents

  1. Overview
  2. Articles
  3. Discussions
  4. Events
  5. Photos
  6. Posts
  7. Profiles
  8. User

Overview

API in current state has 7 endpoints:

  • Articles
  • Discussions
  • Events
  • Photos
  • Posts
  • Profiles
  • User

API will always respond in JSON format. Arguments to endpoints are also in JSON format.

Authorization

Authorization is performed using the JWT token. For all API calls where authorization is needed headers are expected as:

  • Authorization: Bearer <JWT_TOKEN>

Localization

To select the appropriate localization, the culture type should be placed in the request URI in the {culture} part of the URI.

Currently there are two cultures implemented:

  • en-US - errors and messages in English i.e. en-US/api/Articles
  • pl-PL - errors and messages in Polish i.e. pl-PL/api/Events/subscribe

Clone this wiki locally