Class ShieldClient

java.lang.Object

dev.getshield.ShieldClient

public class ShieldClient
extends Object

Official Shield SDK client for Java.

ShieldClient client = new ShieldClient("sk_live_xxx");
ShieldSession session = client.sessions().create("Deal with Acme Corp");

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SDK_USER_AGENT

Constructor Summary

Constructors

Constructor	Description
ShieldClient(String apiKey)
ShieldClient(String apiKey, String baseUrl)
ShieldClient(String apiKey, String baseUrl, String hmacSecret)

Method Summary

Modifier and Type	Method	Description
AgentEventsResource	agent()
EventsResource	events()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
com.fasterxml.jackson.databind.JsonNode	request(String method, String path, Map<String,Object> body)	Perform an HTTP request to the Shield API.
byte[]	requestBytes(String path)	Perform a GET request that returns raw bytes (for PDF export).
SessionsResource	sessions()
VerifyResource	verify()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SDK_USER_AGENT

public static final String SDK_USER_AGENT

See Also:

• Constant Field Values

Constructor Details

ShieldClient

public ShieldClient(String apiKey)

ShieldClient

public ShieldClient(String apiKey,
 String baseUrl)

ShieldClient

public ShieldClient(String apiKey,
 String baseUrl,
 String hmacSecret)

Method Details

sessions

public SessionsResource sessions()

events

public EventsResource events()

verify

public VerifyResource verify()

agent

public AgentEventsResource agent()

request

public com.fasterxml.jackson.databind.JsonNode request(String method,
 String path,
 Map<String,Object> body)

Perform an HTTP request to the Shield API.

requestBytes

public byte[] requestBytes(String path)

Perform a GET request that returns raw bytes (for PDF export).

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()