Skip to content

Commit 6e2b3b7

Browse files
committed
SDK Setup tutorial updated
1 parent 6a08f9b commit 6e2b3b7

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

email/sdk-tutorials/sdk-setup/_index.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -113,49 +113,49 @@ composer require aspose/aspose-email-cloud
113113
{{< /tab >}}
114114

115115
{{< /tabs >}}
116-
## **Get Your App Key and App SID**
117-
Before we will get our **app Key** and **app SID**, let’s find out: what is it and what are they for?
116+
## **Get Your Client secret and Client id**
117+
Before we will get our **Client secret** and **Client id**, let’s find out: what is it and what are they for?
118118

119-
Simply put, **app Key** is a login and **app SID** is a password. You can create more than one app and each one will have it’s own **app Key** and **app SID**. You can use these apps within your services. Using the [Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/#/) helps you to filter the statistics of your applications in [**My Usage** section](https://dashboard.aspose.cloud/#/usage).
119+
Simply put, **Client id** is a login and **Client secret** is a password. You can create more than one app and each one will have it’s own **Client secret** and **Client id**. You can use these apps within your services. Using the [Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/) helps you to filter the statistics of your applications in [**My Usage** section](https://dashboard.aspose.cloud/billing/api-usage).
120120

121-
Here, you see the example of the apps’ statistics. In the APP column, you can see from which application was a request, also, there are details, size and sender’s IP address of a request.
121+
Here, you see the example of the apps’ statistics. In the Application column, you can see from which application was a request, also, there are details, status, and sender’s IP address of a request.
122122

123123
![My Usage section](sdk-setup_1.png)
124124

125-
**App Key** and **app SID** are used to get the temporary **JWT token**, which provides access to the API methods of Aspose.Email Cloud. These tokens can be seen in curl requests generated in the [Swagger UI](https://apireference.aspose.cloud/email/).
125+
**Client secret** and **Client id** are used to get the temporary **JWT token**, which provides access to the API methods of Aspose.Email Cloud. These tokens can be seen in curl requests generated in the [Swagger UI](https://apireference.aspose.cloud/email/).
126126

127127
{{% alert color="primary" %}}
128128
Here you can see a screenshot of the Curl with JWT token:
129129
![Curl with JWT token](sdk-setup_3.png)
130130
{{% /alert %}}
131131

132-
Our SDKs do not require you to receive these tokens again and again as they become obsolete. Instead, the **EmailCloud** class stores **app Key** and **app SID** in itself and receive a token by itself. If the token is out of date, Aspose.Email SDKs automatically receive a new one.
132+
Our SDKs do not require you to receive these tokens again and again as they become obsolete. Instead, the **EmailCloud** class stores **Client secret** and **Client id** in itself and receive a token by itself. If the token is out of date, Aspose.Email SDKs automatically receive a new one.
133133

134-
To get your **app Key** and **app SID** follow these steps:
134+
To get your **Client secret** and **Client id** follow these steps:
135135

136-
1. Open the link of [Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/#/)
136+
1. Open the link of [Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/)
137137
1. Sign in or sign up
138-
1. Open [link](https://dashboard.aspose.cloud/#/apps)
138+
1. Open [link](https://dashboard.aspose.cloud/applications)
139139
1. Now you can create a new app or use First App, which is already created for you.
140-
1. Get **App SID** and **App Key** for your application to use them in SDK (you can also use them in our [Swagger UI](https://apireference.aspose.cloud/email/))
140+
1. Get **Client id** and **Client secret** for your application to use them in SDK (you can also use them in our [Swagger UI](https://apireference.aspose.cloud/email/))
141141

142-
[Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/#/) is a powerful tool where you can control your apps, storages and files.
142+
[Aspose.Cloud Dashboard](https://dashboard.aspose.cloud/) is a powerful tool where you can control your apps, storages and files.
143143

144144
{{% alert color="primary" %}}
145145

146146
For example, you can:
147147

148-
- **See all files** uploaded to the Storage [here](https://dashboard.aspose.cloud/#/files)
149-
- **Create** new storage [here](https://dashboard.aspose.cloud/#/storages).
150-
- **Analyze** API usage [here](https://dashboard.aspose.cloud/#/usage).
148+
- **See all files** uploaded to the Storage [here](https://dashboard.aspose.cloud/files)
149+
- **Create** new storage [here](https://dashboard.aspose.cloud/storages).
150+
- **Analyze** API usage [here](https://dashboard.aspose.cloud/billing/api-usage).
151151

152152
{{% /alert %}}
153153

154154

155155
## **Set up EmailCloud Object**
156-
It is always convenient when everything is in one place. In our case, one of the main classes that will help us in development - [**EmailCloud**](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet/blob/master/docs/README.md).
156+
It is always convenient when everything is in one place. In our case, one of the main classes that will help us in development - **EmailCloud**.
157157

158-
All API methods are available in one [**EmailCloud**](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet/blob/master/docs/README.md) class. To initialize EmailCloud object we need to pass into it 2 required parameters: **App Key** and **App SID** (which are strings).
158+
All API methods are available in one **EmailCloud** class. To initialize EmailCloud object we need to pass into it 2 required parameters: **Client secret** and **Client id** (which are strings).
159159

160160
So, what are we waiting for, let's create an instance of it:
161161

@@ -166,14 +166,14 @@ So, what are we waiting for, let's create an instance of it:
166166
{{< tab tabNum="1" >}}
167167

168168
```csharp
169-
using Aspose.Email.Cloud.Sdk.Api; //EmailApi class is here
169+
using Aspose.Email.Cloud.Sdk.Api; //EmailCloud class is here
170170
using Aspose.Email.Cloud.Sdk.Model; //REST API models are here
171171
172172
...
173173

174-
var appKey = "Your App Key";
175-
var appSid = "Your App SID";
176-
var api = new EmailCloud(appKey, appSid);
174+
var clientSecret = "Your Client secret";
175+
var clientId = "Your Client id";
176+
var api = new EmailCloud(clientSecret, clientId);
177177
```
178178

179179
{{< /tab >}}
@@ -187,7 +187,7 @@ import com.aspose.email.cloud.sdk.api.*;
187187

188188
...
189189

190-
EmailCloud api = new EmailCloud("Your App Key", "Your App SID");
190+
EmailCloud api = new EmailCloud("Your Client secret", "Your Client id");
191191
```
192192

193193
{{< /tab >}}
@@ -199,7 +199,7 @@ from AsposeEmailCloudSdk import api, models
199199

200200
...
201201

202-
api = api.EmailCloud("app_key", "app_sid")
202+
api = api.EmailCloud("client_secret", "client_id")
203203
```
204204

205205
{{< /tab >}}
@@ -212,7 +212,7 @@ include AsposeEmailCloud
212212

213213
...
214214

215-
@api = EmailCloud.new('appKey', 'appSid')
215+
@api = EmailCloud.new('client_secret', 'client_id')
216216
```
217217

218218
{{< /tab >}}
@@ -224,7 +224,7 @@ import * as email from "@asposecloud/aspose-email-cloud";
224224

225225
...
226226

227-
var api = new email.EmailCloud('appSid', 'appKey');
227+
var api = new email.EmailCloud('clientId', 'clientSecret');
228228
```
229229

230230
{{< /tab >}}
@@ -240,8 +240,8 @@ use Aspose\Email\Model;
240240

241241
$configuration = new Configuration();
242242
$configuration
243-
->setAppKey("appKey")
244-
->setAppSid("appSid");
243+
->setClientSecret("clientSecret")
244+
->setClientId("clientId");
245245

246246
$api = new EmailCloud($configuration);
247247
```
@@ -250,16 +250,16 @@ $api = new EmailCloud($configuration);
250250

251251
{{< /tabs >}}
252252

253-
Our SDK automatically gets API token using your **AppKey** and **AppSid**. Also, it automatically gets a new token, if previous one is expired.
253+
Our SDK automatically gets API token using your **clientSecret** and **ClientId**. Also, it automatically gets a new token, if previous one is expired.
254254

255255
## **Check Everything Works**
256256
After setting up Aspose.Email Cloud API SDK, it's time to start using it. The API has numerous functions for working with email messages, calendars, contacts, etc.. Also, the API includes AI functions such as the [Business Card Recognition API](/email/business-cards-recognition-api/) and [Name API](/email/working-with-name-api/). These features will facilitate and speed up the development of your application. 
257257

258258
Let’s call some SDK methods to see that everything set up properly. For example, you can easily convert an **EML** file to **MSG** format with our API.
259259

260-
[EmailApi](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet/blob/master/docs/EmailApi.md) object has a function to convert email messages, it’s called [*ConvertAsync*](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet/blob/master/docs/EmailApi.md#ConvertAsync) which converts email document to the specified format and returns as the file.
260+
[EmailApi](/email/reference-email-api/) object has a function to convert email messages, it’s called [*Convert*](/email/reference-email-api/#convert) which converts email document to the specified format and returns as the file.
261261

262-
This function requires only one parameter — [*ConvertEmailRequest*](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet/blob/master/Model/EmailConvertRequest.cs), which requests a model for conversion. To create a request you need to pass **3 parameters**:
262+
This function requires only one parameter — [*EmailConvertRequest*](/email/reference-model-email-convert-request/), which requests a model for conversion. To create a request you need to pass **3 parameters**:
263263
- toFormat - a **file format** you want to convert to (Enum: Eml, Msg, MsgUnicode, Mhtml, Html).
264264
- fromFormat - a file format you want to convert from.
265265
- file - a **file to upload** for the further converting. 
69.3 KB
Loading

0 commit comments

Comments
 (0)