erpya/proxy-adempiere-api repository overview

⁠Proxy ADempiere-API

⁠What is?

A simple proxy for synchronize ADempiere Backend based on ADempiere-gRPC-Server⁠ with any frontend using RESTful API.

Source repository Proxy-ADempiere-API⁠.

⁠For all enviroment you should run the follow images:

• ADempiere gRPC: https://hub.docker.com/r/erpya/adempiere-grpc-all-in-one⁠

docker pull erpya/adempiere-grpc-all-in-one

• Proxy ADempiere API: https://hub.docker.com/r/erpya/proxy-adempiere-api⁠

docker pull erpya/proxy-adempiere-api

• ADempiere Vue: https://hub.docker.com/r/erpya/adempiere-vue⁠

docker pull erpya/adempiere-vue

⁠Run Docker Container

⁠For development only

Build docker image:

    docker build -t erpya/proxy-adempiere-api:dev -f ./Dockerfile .

⁠Run with default connection

For generate your server you should generate a ADempiere Third Party Access token, see the follow image for generate it from ADempiere installed service

Run Docker Image

docker run -it -d \
	--name proxy-adempiere-api \
	-p 8085:8085 \
	-e AD_DEFAULT_HOST="Your_gRPC_Server_IP" \
	-e AD_DEFAULT_PORT="50059" \
	-e AD_TOKEN="Your_ADempiere_Generated_Token" \
	-e VS_ENV="dev" \
	-e RESTORE_DB="N" \
	erpya/proxy-adempiere-api

⁠Test service

⁠Local Service

A simple test for local service

curl --location --request POST 'http://Your_gRPC_Server_IP:8085/adempiere-api/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "GardenAdmin",
    "password": "GardenAdmin"
}'

Result

{
	"code":200,
	"result":"012c44b6-3ee2-47bd-844e-b1517d405e53"
}

⁠Demo service

A test using API demo

curl --location --request POST 'https://api.erpya.com/adempiere-api/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "demo",
    "password": "demo"
}'

Result

{
	"code":200,
	"result":"c7fcf550-ba93-4a02-968b-3a1712acabec"
}

⁠Environment variables for the configuration

• VS_ENV: Indicates the startup mode in which the RESTful proxy service will start, by default its value is prod, the other value is dev.
• AD_DEFAULT_HOST: Specifies the host to point to the gRPC service, by default its value is localhost. All hosts pointing to gRPC services will take the value you set for this environment variable unless you set a value to overwrite the specific service.
• AD_DEFAULT_PORT: Specifies the listening port to point to the gRPC service, by default its value is 50059. All ports to be pointed to from gRPC services will take the value you set for this environment variable unless you set a value to overwrite the specific service.
• AD_ACCESS_HOST: If not set it takes the value of AD_DEFAULT_HOST, it is used to indicate the host for the adempiere access grpc service.
• AD_ACCESS_PORT: If not set it takes the value of AD_DEFAULT_PORT, it is used to indicate the port for the adempiere access grpc service.
• AD_BUSINESS_HOST: If not set it takes the value of AD_DEFAULT_HOST, it is used to indicate the host for the adempiere business data grpc service.
• AD_BUSINESS_PORT: If not set it takes the value of AD_DEFAULT_PORT, it is used to indicate the port for the adempiere business data grpc service.
• AD_DICTIONARY_HOST: If not set it takes the value of AD_DEFAULT_HOST, it is used to indicate the host for the adempiere dictionary grpc service.
• AD_DICTIONARY_PORT: If not set it takes the value of AD_DEFAULT_PORT, it is used to indicate the port for the adempiere dictionary grpc service.
• AD_STORE_HOST: If not set it takes the value of AD_DEFAULT_HOST, it is used to indicate the host for the adempiere store data grpc service.
• AD_STORE_PORT: If not set it takes the value of AD_DEFAULT_PORT, it is used to indicate the port for the adempiere store data grpc service.
• AD_STORE_ACCESS_HOST: It is used to indicate the host for the adempiere access store grpc service. If not set it takes the value of AD_STORE_HOST (and if that is not defined then it takes the value of AD_DEFAULT_HOST).
• AD_STORE_ACCESS_PORT: It is used to indicate the port for the adempiere access store grpc service. If not set it takes the value of AD_STORE_PORT (and if that is not defined then it takes the value of AD_DEFAULT_PORT).
• ES_HOST: Indicates the host to point to where the elastic search service is, by default its value is localhost.
• ES_PORT: Indicates the listening port of the elastic search service to be pointed to, by default its value is 9200.
• INDEX: Eslastic Search index (is like a ‘database’ in a relational database).
• REDIS_HOST: Indicates the host to point to where the redis service is, by default its value is localhost.
• REDIS_PORT: Indicates the listening port of the redis service to be pointed to, by default its value is 6379.
• REDIS_DB: Indicates the data base to be pointed to, by default its value is 0.
• API_URL_IMAGES: By default its value is localhost.
• API_HTTP_BASED: By default its value is false.
• STORE_URL_IMAGES: By default its value is localhost.
• STORE_HTTP_BASED: By default its value is false.
• AD_TOKEN: ADempiere access token.
• AD_STORE_TOKEN: Store access token.