Adapter.Akka.Intro

			 |## Use Akka as an interface between OBP and your Core Banking System (CBS).

| |For an introduction to Akka see here | |The OBP Akka interface allows integrators to write Java or Scala Adapters (any JVM language with Akka support) |respond to requests for data and services from OBP. | |For the message definitions see here | |### Installation Prerequisites | | |* You have OBP-API running. | |* Ideally you have API Explorer running (the application serving this page) but its not necessary - you could use any other REST client. |* You might want to also run API Manager as it makes it easier to grant yourself roles, but its not necessary - you could use the API Explorer / any REST client instead. | | |### Create a Customer User and an Admin User | |* Register a User who will use the API as a Customer. |* Register another User that will use the API as an Admin. The Admin user will need some Roles. See here. You can bootstrap an Admin user by editing the Props file. See the README for that. | |### Add some authentication context to the Customer User | |* As the Admin User, use the Create Auth Context endpoint to add one or more attributes to the Customer User. |For instance you could add the name/value pair CUSTOMER_NUMBER/889763 and this will be sent to the Adapter / CBS inside the AuthInfo object. | | |Now you should be able to use the Get Auth Contexts endpoint to see the data you added. | |### Write or Build an Adapter to respond to the following messages. | | When getting started, we suggest that you implement the messages in the following order: | |1) Core (Prerequisites) - Get Adapter, Get Banks, Get Bank | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getAdapterInfo">obp.getAdapterInfo</a> | |Now you should be able to use the Adapter Info endpoint | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getBanks">obp.getBanks</a> | |Now you should be able to use the Get Banks endpoint | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getBank">obp.getBank</a> | |Now you should be able to use the Get Bank endpoint | | |2) Get Customers by USER_ID | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getCustomersByUserId">obp.getCustomersByUserId</a> | |Now you should be able to use the Get Customers endpoint. | | |3) Get Accounts | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.checkBankAccountExists">obp.checkBankAccountExists</a> |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getCoreBankAccounts">obp.getCoreBankAccounts</a> | | The above messages should enable at least the following endpoints: | |* Get Accounts at Bank (IDs only) |* Get Accounts at Bank (Minimal). |* Get Accounts at all Banks (private) | |4) Get Account | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getBankAccount">obp.getBankAccount</a> | | The above message should enable at least the following endpoints: | |* Get Account by Id - Core |* Get Account by Id - Full | |5) Get Transactions | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getTransactions">obp.getTransactions</a> |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getTransaction">obp.getTransaction</a> | |6) Manage Counterparties | |* <a href="http://localhost:5174/message-docs/akka_vDec2018#obp.getCounterparties">obp.getCounterparties</a> | |7) Get Transaction Request Types | |* This is configured using OBP Props - No messages required | | |This glossary item is Work In Progress. |