API

Roava api service provides the graphql api to the clients. The api service connects with all other microservices to handle the mutations and queries.
Features · Graphql API · Zebra

Table of Contents

1. Getting Started
   • Prerequisites
2. Events
3. Errors

---

🚀 Getting Started

🛠 Prerequisites

• 🐳 Make sure that your docker is installed and up-to-date.

# Setup pulsar steam locally
$ make docker-pulsar
# Run mongodb cluster for DB support
$ make docker-mongo

---

Run application locally

1. Setup needed keys inside local.yml

SERVICE_NAME: "api"
PORT: "2000"
mongodb_uri: "mongodb://127.0.0.1:27017"
pulsar_url: "pulsar://127.0.0.1:6650"

# Microservices urls
onboarding_service_url: "127.0.0.1:<SERVICE_PORT>"
verification_service_url: "127.0.0.1:<SERVICE_PORT>"
auth_service_url: "127.0.0.1:<SERVICE_PORT>"
account_service_url: "127.0.0.1:<SERVICE_PORT>"
customer_service_url: "127.0.0.1:<SERVICE_PORT>"
payment_service_url: "127.0.0.1:<SERVICE_PORT>"
pricing_service_url: "127.0.0.1:<SERVICE_PORT>"
messaging_service_url: "127.0.0.1:<SERVICE_PORT>"

2. Use those command to setup local environment.

$ export environment=local #or use dedicated environment name
$ make local

It's possible to force the environment (without setting environment variable globally) by using the below command:

# Force environment
$ make local environment=local

---

❌ Errors

Name	Payload	Message
InvalidEmailError	1100	invalid email address
InvalidPhoneNumberException	7010	phone number is not valid
InvalidPassword	7010	Your transaction password must have at least one number and at least one letter and must be at least 8-characters long.
InvalidPayeeDetails	7011	Invalid payee account details
InvalidPaymentDetails	7012	Invalid payment details
InvalidPassCode	7011	invalid pass code
InternalErr	7021	failed to process the request, please try again later.
ErrInvalidDateFormat	7007	invalid date format. Date format must be dd/mm/yyyy
ErrInvalidType	7008	not a valid date
ErrInvalidAge	7009	minimum age requirement for using Roava is 18years
InvalidRequestErr	7103	invalid request error, failed to parse event