API Client implementation in Go¶
- API Key authentication
- Basic authentication
- Making a list GET request
- Making a read GET request
- Making a create POST request
- Making an update PUT request
- Making a delete DELETE request
Note
This is an unofficial (3rd party) client.
For the source code, refer to GitHub.
Using API Key Authentication¶
```go import "github.com/definitepotato/espocrm"
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), ) ```
Using Basic Authentication¶
(this is highly discouraged)
```go import "github.com/definitepotato/espocrm"
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithBasicAuth("username", "password"), ) ```
Making a list GET request¶
```go import "github.com/definitepotato/espocrm"
parameters := espocrm.NewParameters( espocrm.SetWhere([]espocrm.Where{ { Type: espocrm.Equals, Attribute: "myAttribute", Value: "myValue", }, }), )
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), )
contacts, err := client.List("Contact", parameters) ```
Making a read GET request¶
```go import "github.com/definitepotato/espocrm"
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), )
contact, err := client.Read("Contact", "78abc123def456") ```
Making a create POST request¶
```go import "github.com/definitepotato/espocrm"
newContact := "{ "name": "Test", "assignedUserId": "1" }"
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), )
attributes, err := client.Create("Contact", newContact) ```
Making an update PUT request¶
```go import "github.com/definitepotato/espocrm"
contactID := "993bdd81479dff4"
updatePayload := "{ assignedUserId": "1" }"
client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), )
attributes, err := client.Update("Contact", contactID, updatePayload) ```
Making a delete DELETE request¶
```go import "github.com/definitepotato/espocrm"
contactID := "78abc123def456" client := espocrm.NewApiClient( "https://espocrm.example.com", espocrm.WithApiKeyAuth("Your API Key here"), )
status, err := client.Delete("Contact", contactID) ```