Commit 30a42853 authored by nacho's avatar nacho
Browse files

Update Readme

parent 1ef30688
Loading
Loading
Loading
Loading
+42 −0
Original line number Diff line number Diff line
@@ -7,6 +7,15 @@ The purpose of this backoffice is to operate on the CAPIF resources (Invokers/ P
## Prerequisites
You need to have a full CAPIF instance running (check this link <https://github.com/EVOLVED-5G/CAPIF_API_Services>)

To execute operations on CAPIF it is necessary to have certificates issued by CAPIF. To obtain them once the CAPIF instance is raised, execute the following code

```
cd cert
python create_cert_to_capif.py

```
This python script Creates a csr request, sends it to CAPIF to be signed, and gets the ca root from CAPIF.

## How to launch the backend

1. (Optional) Run pipenv
@@ -37,3 +46,36 @@ mongo: {
python main.py
```



## Current state and work in progress

1. Current Features
    - Provide Tokens and Refresh Tokens
    - List of Invokers registered in CAPIF
    - List of Provider registered in CAPIF
    - List of Services registered in CAPIF by providers
    - List of Events Subscriptions registered in CAPIF by Invokers/Providers
    - List of Security Context registered in CAPIF by Invokers
    - Delete of Security Context registered in CAPIF

2. Pending Features

    - Delete Invokers registered in CAPIF
    - Delete Providers registered in CAPIF
    - Delete Services registered in CAPIF by providers
    - Delete Events Subscriptions registered in CAPIF by Invokers/Providers
    - Delete Security Context registered in CAPIF by Invokers

## Endpoint routes

```
http://<hostname>:<port>/login
http://<hostname>:<port>/refresh
http://<hostname>:<port>/resources/invokers
http://<hostname>:<port>/resources/invokers/security/<invoker_id>
http://<hostname>:<port>/resources/invokers/events/<invoker_id>
http://<hostname>:<port>/resources/providers
http://<hostname>:<port>/resources/providers/services/<apf_id>
http://<hostname>:<port>/resources/providers/events/<aef_id>
```
 No newline at end of file