apxtrib/api/middlewares/header.md

api users and backend developers

api documentation for routes and middleware has to respect apidoc's rules https://apidocjs.com/ 

To update this doc accessible in https://wal-ants.ndda.fr/cdn/apidoc :

yarn apidoc 

For api tribe's doc  accessible in https://smatchit.io/cdn/apidoc : 

yarn apidoctribename

Objects manage in apXtrib: pagans, notifications, nations, towns, tribes, wwws 

All others objects are manage in town/tribe 

persons is the only exception, schema is manage in apXtrib but data are store in a tribe.

apxtrib conf is set in a conf.json at the same folder level:

/apxtrib/                          # core process 
/townName_nationName/conf.json     # town settings

url: /api/routeName For core api apXtrib in /apxtrib :

/apxtrib/api/middlewares/
/apxtrib/api/routes/
/apxtrib/api/models/
/apxtrib/api/models/lg/ language customisation for api response
/apxtrib/api/models/unitest/

url: /api/smatchit/routeName for tribe smatchit example api in /town_nation/tribes/smatchit(tribeid) 

/town_nation/tribes/smatchit/api/routes/
/town_nation/tribes/smatchit/api/models/
/town_nation/tribes/smatchit/api/models/lg/ language  customization 

static files are served by nginx, each tribe nginx conf are store and can be customize in /town_nation/www/nginx_xtribe_xapp.conf

object www/websitename are serve with nginx not express.

Object management (Odmdb)

An object has a name and is defined by a schema that contain properties key.

A propertie has a name and a list of caracteristics (type, pattern,format,...) that have to be validate to be accepted.
All properties respect the rules https://json-schema.org/draft/2020-12/schema, some extra"format" can be add to mutualise recurrent regex pattern

A checkjson.js is available to manage all specific format https://wall-ants.ndda.fr/Checkjson.js see Odmdb - schema Checkjson

Additional properties that not exist in 2020-12/schema :

required: an array of required properties

apxid: the propertie used as an unique id

apxuniquekey: array of unique properties

apxidx : array of index

apxaccessrights: object with key profilname and accessrights on properties {profilname:{C:[properties array],R:[properties array],U:[],D:[]}}

Items of an object are store in files into :  

/objectnames/idx/keyval_objkey.json
/objectnames/itm/uniqueid.json

api pre-request

Valid header

A ‘private’ request to pass must contain exposeHeaders from town conf.json

api.exposedHeaders :["xdays", "xhash", "xalias", "xlang", "xtribe", "xapp", "xuuid" ]

By default for anonymous user:

{"headers":{
    "xtrkversion":1,
    "xtribe":"tribeid ex: smatchit",
    "xapp":"websitename ex:presentation",
    "xlang":"fr",
    "xalias":"anonymous",
    "xhash":"anonymous",
    "xdays":0
  }
}

App use openpgp.js lib to sign xdays_xalias with a privatekey and store it in xhash.

/api/middlewares/isAuthenticated.js check if (xhash) is a valid signature of the public key a xhash is valid for 24 hours

See Pagans models that contain authentification process

api Return can be direct json in case of get without authenntification or an object data

{status, ref,msg,data}:

• status: http code return
• ref: model/route name reference where message come from
• msg: a message template key store into models/lg/name_lg.json (where lg is 2 letters language)
• data: an object data use to render the value of the message key.

Accessrights:

An alias is just an identity, to access a tribe a person must exist with alias into /town/tribes/tribename/persons/itm/alias.json

A person has a property profils with a list of profilename, common profiles are : pagan (an identity)  / person (an identity with access right in a tribe) / druid (the administrator of a tribe) / major (administrator of a town/server)

Into a tribe you can have many other profil with specifics accessright on tribe's object.

Add tribe's api:

Accessible with https://dns/api/tribename/routes

/town/tribes/tribename/api/routes
/town/tribes/tribename/api/middlewares
/town/tribes/tribename/api/models
/town/tribes/tribename/schema
/town/tribes/tribename/schema/lg

// Example of a route
const conf = require(`${process.env.dirtown}/conf.json`);
const express = require(`${conf.dirapi}/node_modules/express`);
const fs = require(`${conf.dirapi}/node_modules/fs-extra`);
const path = require(`${conf.dirapi}/node_modules/path`);

const Nofications = require(`${conf.dirapi}/api/models/Notifications.js`);

// Middlewares
const checkHeaders = require(`${conf.dirapi}/api/middlewares/checkHeaders`);
const isAuthenticated = require(`${conf.dirapi}/api/middlewares/isAuthenticated`);
const Actions = require(`${conf.dirtown}/tribes/smatchit/api/models/Actions`);
const router = express.Router();