Skip to content

README.md

Latest commit

 

History

History
86 lines (66 loc) · 7.9 KB

README.md

File metadata and controls

86 lines (66 loc) · 7.9 KB

Proxy

Overview

Routing API requests through StackOne directly to the underlying provider.

Available Operations

proxyRequest

Proxy Request

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.ProxyRequestBody;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneProxyRequestResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        StackoneProxyRequestResponse res = sdk.proxy().proxyRequest()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .proxyRequestBody(ProxyRequestBody.builder()
                    .url("https://api.sample-integration.com/v1")
                    .path("/employees/directory")
                    .headers(Map.ofEntries(
                        Map.entry("Content-Type", "application/json")))
                    .build())
                .call();

        if (res.proxyResponseApiModel().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
xAccountId String ✔️ The account identifier
prefer Optional<String> ➖ Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) heartbeat
proxyRequestBody ProxyRequestBody ✔️ The request body

Response

StackoneProxyRequestResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/PreconditionFailedResponse 412 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*