Package dev.array21.espocrm.client

Class EspoApiClient

java.lang.Object

dev.array21.espocrm.client.EspoApiClient

public class EspoApiClient
extends Object

A client for the EspoCRM API

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiKey
protected String	password
protected String	secretKey
protected String	url
protected String	username

Constructor Summary

Constructors

Constructor	Description
EspoApiClient()

Method Summary

Modifier and Type	Method	Description
<T> String	request(Method method, String action, T payload)	Send a POST, PUT or DELETE request to EspoCRM
String	requestGet(String action, Params params)	Send a GET request to EspoCRM

Methods inherited from class java.lang.Object

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

Field Details

url

protected String url

username

protected String username

password

protected String password

apiKey

protected String apiKey

secretKey

protected String secretKey

Constructor Details

EspoApiClient

public EspoApiClient()

Method Details

requestGet

public String requestGet(String action,
 Params params)
                  throws InvalidKeyException,
IOException,
RequestException

Send a GET request to EspoCRM

Parameters:

action - The action (i.e URL path)

params - The parameters to use

Returns:

Returns the JSON response

Throws:

InvalidKeyException - Thrown only when using HMAC authorization, if the key is invalid

IOException

RequestException

request

public <T> String request(Method method,
 String action,
 T payload)
                   throws InvalidKeyException,
IOException,
RequestException

Send a POST, PUT or DELETE request to EspoCRM

Type Parameters:

T - The type of payload, this will be serialized using Google's GSON

Parameters:

method - The request method

action - The action (i.e URL path)

payload - The payload to send along with the request. This will be serialized using Google's GSON

Returns:

Returns the JSON response

Throws:

InvalidKeyException - Thrown only when using HMAC authorization, if the key is invalid

IOException

RequestException