03 APIs
Introduction
This page describes the one API offered by the proxy service that enables rerouting between environments.
API
Service | API | Method |
---|---|---|
proxy | /redirect | POST |
Workflow: Check Redirect Workflow
Input
Name | Source | Mandatory | Type | Special Format | Description |
---|---|---|---|---|---|
_env | body | YES | String | N/A | The code of the environment to redirect to. |
_envauth | body | YES | String | N/A | The soajsauth of the environment the calls is redirected to. |
proxyRoute | body | YES | String | N/A | An encoded value of the service/api to redirect to in the requested environment. |
Example
Proxy call example
CURL -X POST "http://127.0.0.1:4000/proxy/redirect?__env=dev&__envauth=Basic c29hanM6QzAzYmhnVWhSeEx4bUhURjFNUkFsVnh5Zi1VMzNNQXNnV2Y=&proxyRoute=%2serviceName%2FapiName" -d '%data that should be provided to the service deployed in the requested environment%'
Response:
Since the proxy only reroutes the request to the designated service, the response is thus dependent on the API being invoked from the requested service.