Commit 035d44d0 authored by Guillermo Sanz López's avatar Guillermo Sanz López
Browse files

readme

parent 9cc617e3
Loading
Loading
Loading
Loading
+47 −0
Original line number Diff line number Diff line
@@ -2,3 +2,50 @@
This repo contains backoffice backend.

The purpose of this backoffice is to operate on the CAPIF resources (Invokers/ Provider and associated resources) being able to perform listing and deletion operations on them.

## Prerequisites
You need to have a full CAPIF instance running (check this link https://github.com/Telefonica/CAPIF_Future_Network_Lab.git)

To execute operations on CAPIF it is necessary to have certificates issued by CAPIF. This certiticate is automaticatically generated when you start the application.



## How to launch the backend

To run using docker and docker compose, version 2.10 or higher, you must ensure you have that tools installed at your machine.
```
docker-compose up -d
```

## Endpoint routes

```
http://<hostname>:<port>/login
http://<hostname>:<port>/refresh
http://<hostname>:<port>/auth/me
http://<hostname>:<port>/resources/invokers
http://<hostname>:<port>/resources/numInvokers
http://<hostname>:<port>/resources/providers
http://<hostname>:<port>/resources/numProviders
http://<hostname>:<port>/resources/security/<invoker_id>
http://<hostname>:<port>/events/<invoker_id>
http://<hostname>:<port>/resources/providers/services/<id>
http://<hostname>:<port>/resources/users
http://<hostname>:<port>/resources/users/<user_id>
http://<hostname>:<port>/resources/users/numUsers
http://<hostname>:<port>/invokers/<invoker_id>
http://<hostname>:<port>/resources/<provider_id>
```

## Current state and work in progress

1. Current Features
    - List of Invokers registered in CAPIF
    - List of Provider registered in CAPIF
    - List of Services registered in CAPIF by providers
    - Provide Tokens and Refresh Tokens

2. Pending Features
    - Events Subscriptions
    - Manage security context
    - Refresh tokens