Building the API client library requires Maven to be installed.
To install the API client library to your local Maven repository, simply execute:
mvn installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deployRefer to the official documentation for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>com.clients.saasgrids</groupId>
<artifactId>saasgrids</artifactId>
<version>1.2.0</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
compile "com.clients.saasgrids:saasgrids:1.2.0"At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/saasgrids-1.2.0.jar
- target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import crms.*;
import crms.auth.*;
import saasgrids.*;
import saasgrids.AccountsApi;
import java.io.File;
import java.util.*;
public class AccountsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AccountsApi apiInstance = new AccountsApi();
String userId = "userId_example"; // String | User instance id returned from saasgrids after authorization
Account body = new Account(); // Account | Account object that needs to be created
try {
apiInstance.createAccount(userId, body);
} catch (ApiException e) {
System.err.println("Exception when calling AccountsApi#createAccount");
e.printStackTrace();
}
}
}All URIs are relative to https://api.saasgrids.com/apis/crms/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | createAccount | POST /{userId}/accounts | Creates a new account |
| AccountsApi | deleteAccountById | DELETE /{userId}/account/{accountId} | Delete account by Id |
| AccountsApi | getAccountById | GET /{userId}/account/{accountId} | Get account by Id |
| AccountsApi | getAccountFilters | GET /{userId}/accounts/filters | Get all account filters |
| AccountsApi | getAccountsByFilter | GET /{userId}/accounts/filters/{filterId} | Get all accounts by filter |
| AccountsApi | getAllAccounts | GET /{userId}/accounts | Get all accounts |
| AccountsApi | updateAccountById | PUT /{userId}/account/{accountId} | Update account by Id |
| AppointmentsApi | createAppointment | POST /{userId}/appointments | Creates a new appointment |
| AppointmentsApi | deleteAppointmentsById | DELETE /{userId}/appointments/{appointmentId} | Delete appointments by Id |
| AppointmentsApi | getAllAppointments | GET /{userId}/appointments | Get all appointments |
| AppointmentsApi | getAppointmentById | GET /{userId}/appointments/{appointmentId} | Get appointment by Id |
| AppointmentsApi | updateAppointmentById | PUT /{userId}/appointments/{appointmentId} | Update appointment by Id |
| ContactsApi | createContact | POST /{userId}/contacts | Creates a new contact |
| ContactsApi | deleteContactById | DELETE /{userId}/contacts/{contactId} | Delete contact by Id |
| ContactsApi | getAllContacts | GET /{userId}/contacts | Get all contacts |
| ContactsApi | getContactByFilter | GET /{userId}/contacts/filters/{filterId} | Get all contacts by filter |
| ContactsApi | getContactById | GET /{userId}/contacts/{contactId} | Get contact by Id |
| ContactsApi | getContactFilters | GET /{userId}/contacts/filters | Get all contact filters |
| ContactsApi | updateContactById | PUT /{userId}/contacts/{contactId} | Update contact by Id |
| DealsApi | createDeals | POST /{userId}/deals | Creates a new deals |
| DealsApi | deleteDealById | DELETE /{userId}/deal/{dealId} | Delete deal by Id |
| DealsApi | getAllDeal | GET /{userId}/deals | Get all deal |
| DealsApi | getDealById | GET /{userId}/deal/{dealId} | Get deal by Id |
| DealsApi | updateDealById | PUT /{userId}/deal/{dealId} | Update deal by Id |
| LeadsApi | createLead | POST /{userId}/leads | Creates a new lead |
| LeadsApi | deleteLeadById | DELETE /{userId}/leads/{leadId} | Delete lead by Id |
| LeadsApi | getAllLeads | GET /{userId}/leads | Get all leads |
| LeadsApi | getLeadById | GET /{userId}/leads/{leadId} | Get lead by Id |
| LeadsApi | getLeadFilters | GET /{userId}/leads/filters | Get all lead filters |
| LeadsApi | getLeadsByFilter | GET /{userId}/leads/filters/{filterId} | Get all leads by filter |
| LeadsApi | updateLeadById | PUT /{userId}/leads/{leadId} | Update lead by Id |
| NotesApi | createNote | POST /{userId}/notes | Creates a new note |
| NotesApi | deleteNoteById | DELETE /{userId}/note/{noteId} | Delete note by Id |
| NotesApi | getAllNotes | GET /{userId}/notes | Get all notes |
| NotesApi | getNoteById | GET /{userId}/note/{noteId} | Get note by Id |
| NotesApi | updateNoteById | PUT /{userId}/note/{noteId} | Update note by Id |
| TasksApi | createTask | POST /{userId}/tasks | Creates a new task |
| TasksApi | deleteTaskById | DELETE /{userId}/tasks/{taskId} | Delete task by Id |
| TasksApi | getAllTasks | GET /{userId}/tasks | Get all tasks |
| TasksApi | getTaskById | GET /{userId}/tasks/{taskId} | Get task by Id |
| TasksApi | updateTaskById | PUT /{userId}/tasks/{taskId} | Update task by Id |
| UsersApi | getUsers | GET /{userId}/users | Get all users |
- Account
- Appointment
- Contact
- Customfield
- Deal
- Filter
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- Lead
- Note
- Task
- User
Authentication schemes defined for the API:
- Type: HTTP basic authentication
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.