summaryrefslogtreecommitdiffstats
path: root/docs/architecture/architecture.rst
blob: f5b03d85382c9b59f1d80b716c208379df884d24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.. This work is licensed under
.. a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 ORANGE


Architecture
============

************
Introduction
************


NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be
used by external systems as BSS for example.
These API are based on **TMF API**.


*******************************************
Global NBI architecture for Beijing release
*******************************************

Following illustration provides a global view about NBI architecture,
integration with other ONAP components and API resource/operation provided.

.. image:: images/ONAP_External_ID_Beijing.jpg
   :width: 800px


***************
Developer Guide
***************

Technical information about NBI
(dependencies, configuration, running & testing)
could be found here: :doc:`NBI_R1_Developer_Guide <NBI_R1_Developer_Guide>`

API Flow illustration (with example messages) is described in this document:
:download:`nbicallflow.pdf <../offeredapis/pdf/nbicallflow.pdf>`