grassrootseconomics/cic-dw
5
0
Fork 0
mirror of https://github.com/GrassrootsEconomics/cic-dw.git synced 2024-11-16 12:36:46 +01:00
Code Issues Projects Releases Wiki Activity
fe0e102a61
cic-dw/docs/api.md
Mohamed Sohail 77f127e14a
feat: add admin/auth api (#22) 
* feat: add admin/auth api

- jwt cookie based auth
- /auth
- admin/*

* add: meta proxy

* fix: remove ussd account status from syncer

* add: cookie defaults and nuxt init check route

* add: pin and address handlers
2022-06-02 11:24:58 +03:00

1.1 KiB
Raw Blame History

API

The data warehouse additionally exposes a couple of REST API's (GraphQL planned):

  1. Dashboard API (/dashboard) - Exposes data for cic-dashboard. Most data is expected to be chart/table API specific and usually not human readable.
  2. Public API (/public) - Exposes public (on-chain only/non-sensitive) data.
  3. Internal Admin API - back office operations

Each API is domain separated i.e. separate SQL query files and router control.

Pagination

Some API endpoints use a modified cursor pagination. This is to avaoid uncessary full db scans and clientside bloat when paginating data for tables.

The pagination expects the following query string:

  • ?per_page= (int) - No. of items to return. Has a hard limit of 100
  • ?forward= (boolean) - If true, scrolls forward else backwards
  • ?cursor= (id:int) - Used with the forward query. If pagination forwards, pass in the id of the last result i.e. results[length(results) - 1]. If paginating backwards pass the id of the first element of the current result set i.e. results[0].