1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
# Usage
Usage examples for SendGrid REST library
## Initialization
```go
package main
import (
"encoding/json"
"fmt"
"os"
"github.com/sendgrid/rest"
)
// Build the URL
const host = "https://api.sendgrid.com"
endpoint := "/v3/api_keys"
baseURL := host + endpoint
// Build the request headers
key := os.Getenv("SENDGRID_API_KEY")
Headers := make(map[string]string)
Headers["Authorization"] = "Bearer " + key
```
## Table of Contents
- [GET](#get)
- [DELETE](#delete)
- [POST](#post)
- [PUT](#put)
- [PATCH](#patch)
<a name="get"></a>
## GET
#### GET Single
```go
method = rest.Get
// Make the API call
request = rest.Request{
Method: method,
BaseURL: baseURL + "/" + apiKey,
Headers: Headers,
}
response, err = rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Body)
fmt.Println(response.Headers)
}
```
#### GET Collection
```go
method := rest.Get
// Build the query parameters
queryParams := make(map[string]string)
queryParams["limit"] = "100"
queryParams["offset"] = "0"
// Make the API call
request := rest.Request{
Method: method,
BaseURL: baseURL,
Headers: Headers,
QueryParams: queryParams,
}
response, err := rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Body)
fmt.Println(response.Headers)
}
```
<a name="delete"></a>
## DELETE
```go
method = rest.Delete
// Make the API call
request = rest.Request{
Method: method,
BaseURL: baseURL + "/" + apiKey,
Headers: Headers,
QueryParams: queryParams,
}
response, err = rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Headers)
}
```
<a name="post"></a>
## POST
```go
method = rest.Post
// Build the request body
var Body = []byte(`{
"name": "My API Key",
"scopes": [
"mail.send",
"alerts.create",
"alerts.read"
]
}`)
// Make the API call
request = rest.Request{
Method: method,
BaseURL: baseURL,
Headers: Headers,
QueryParams: queryParams,
Body: Body,
}
response, err = rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Body)
fmt.Println(response.Headers)
}
// Get a particular return value.
// Note that you can unmarshall into a struct if
// you know the JSON structure in advance.
b := []byte(response.Body)
var f interface{}
err = json.Unmarshal(b, &f)
if err != nil {
fmt.Println(err)
}
m := f.(map[string]interface{})
apiKey := m["api_key_id"].(string)
```
<a name="put"></a>
## PUT
```go
method = rest.Put
// Build the request body
Body = []byte(`{
"name": "A New Hope",
"scopes": [
"user.profile.read",
"user.profile.update"
]
}`)
// Make the API call
request = rest.Request{
Method: method,
BaseURL: baseURL + "/" + apiKey,
Headers: Headers,
Body: Body,
}
response, err = rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Body)
fmt.Println(response.Headers)
}
```
<a name="patch"></a>
## PATCH
```go
method = rest.Patch
// Build the request body
Body = []byte(`{
"name": "A New Hope"
}`)
// Make the API call
request = rest.Request{
Method: method,
BaseURL: baseURL + "/" + apiKey,
Headers: Headers,
Body: Body,
}
response, err = rest.API(request)
if err != nil {
fmt.Println(err)
} else {
fmt.Println(response.StatusCode)
fmt.Println(response.Body)
fmt.Println(response.Headers)
}
```
|
