Skip to content

Commit 1bd8d63

Browse files
authored
Platform: How to Sign Up and Sign In (#346)
1 parent d6b4a3e commit 1bd8d63

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+226
-134
lines changed

api-reference/api-services/saas-api-development-guide.mdx

Lines changed: 87 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,53 @@ description: This page describes how to get started with the Unstructured Server
77

88
To call the Unstructured Serverless API, you need an API key and API URL:
99

10-
1. Go to [https://app.unstructured.io](https://app.unstructured.io).
11-
2. Enter your email address and then click **Sign In** to receive a magic link to sign in to your personalized dashboard, or authenticate yourself with your Google or GitHub account.
12-
3. Once you authenticate with the magic link or with your Google or GitHub account, your dashboard appears.
13-
4. On the sidebar, click **API Keys**, if it is not already selected.
14-
5. To get your API key, click the copy icon in the **Actions** column for your API key. Store your copied API key in a secure location. Do not share it with others.
15-
6. To get your API URL, click the copy icon next to the URL next to **API URL**. Store your copied API URL in a secure location. Do not share it with others.
10+
<Steps>
11+
<Step title="Sign up">
12+
Go to the [For Developers](https://unstructured.io/developers) page and enter your information.
13+
14+
<Note>
15+
By signing up through the [For Developers](https://unstructured.io/developers) page, your Unstructured account will run within the context of the Unstructured Platform on
16+
Unstructured's own hosted cloud resources. Also, after your first 14 days of usage or more than 1000 processed pages per day,
17+
whichever comes first, your account is then billed at Unstructured's standard service usage rates. You can always
18+
start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription,
19+
contact Unstructured Sales at [[email protected]](mailto:[email protected]).
20+
21+
If you would rather run the Unstructured Platform within the context of your own virtual private cloud (VPC),
22+
or you want to make a long-term billing commitment in exchange for deeply discounted service usage rates,
23+
stop here and sign up through the [For Enterprise](https://unstructured.io/enterprise) page instead.
24+
</Note>
25+
</Step>
26+
<Step title="Sign in">
27+
![Sign in to your Unstructured account](/img/platform/Signin.png)
28+
1. After you have signed up through the [For Developers](https://unstructured.io/developers) page, the Unstructured Platform sign-in page appears.
29+
30+
<Note>
31+
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your sign-in process will
32+
be different. For enterprise sign-in guidance, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
33+
</Note>
34+
35+
2. Click **Google** or **GitHub** to sign in with the Google or GitHub account that you signed up with through the **For Developers** page.
36+
Or, enter the email address that you signed up with, and then click **Sign In**.
37+
3. If you entered your email address, check your email inbox for a message from Unstructured. In that email, click the **Sign In** link.
38+
4. The first time you sign in, read the terms and conditions, and then click **Accept**.
39+
40+
<Tip>
41+
After you have signed in through the [For Developers](https://unstructured.io/developers) page for the first time, you can
42+
sign in the second time and beyond by going to the Unstructured home page at [https://unstructured.io](https://unstructured.io) and clicking **Login**.
43+
44+
For enterprise sign-in guidance, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
45+
</Tip>
46+
</Step>
47+
<Step title="Get your API key and API URL">
48+
![Unstructured account settings](/img/platform/AccountSettings.png)
49+
50+
![Unstructured API key and API URL](/img/platform/APIKeyURL.png)
51+
1. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
52+
2. On the account settings sidebar, click **API Keys**, if it is not already selected.
53+
3. To get your API key, click the copy icon in the **Actions** column for your API key, and then click **Key Only**. Store your copied API key in a secure location. Do not share it with others.
54+
4. To get your API URL, click the copy icon next to the URL next to **API URL**. Store your copied API URL in a secure location. Do not share it with others.
55+
</Step>
56+
</Steps>
1657

1758
import ServerlessKeyNoFreeURL from '/snippets/general-shared-text/serverless-api-key-no-free-access.mdx';
1859

@@ -22,43 +63,39 @@ import ServerlessKeyNoFreeURL from '/snippets/general-shared-text/serverless-api
2263

2364
## Set up billing
2465

25-
<iframe
26-
width="560"
27-
height="315"
28-
src="https://www.youtube.com/embed/DPITllKgYvA"
29-
title="YouTube video player"
30-
frameborder="0"
31-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
32-
allowfullscreen
33-
></iframe>
66+
Once you sign up for the Unstructured Serverless API through the [For Developers](https://unstructured.io/developers) page, you can enjoy a free 14-day trial with usage capped at 1000 pages per day.
3467

35-
Once you sign up for the Unstructured Serverless API, you can enjoy a free 14-day trial with usage capped at 1000 pages per day.
36-
37-
<Info>The free 14-day trial for the Unstructured Serverless API is different than the [Free Unstructured API](/api-reference/api-services/free-api).</Info>
68+
<Note>
69+
If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page instead, your billing setup and terms will
70+
be different. For enterprise billing guidance, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
71+
72+
The free 14-day trial for the Unstructured Serverless API is different than the [Free Unstructured API](/api-reference/api-services/free-api).
73+
</Note>
3874

3975
At the end of the 14-day free trial, or if you need to go past the trial's page processing limits during the 14-day free trial, you must set up your billing information to keep using
4076
the Unstructured Serverless API:
4177

42-
1. Go to [https://app.unstructured.io](https://app.unstructured.io) and sign in.
43-
2. On the sidebar, click **Billing**.
44-
3. Click **Manage Payment Method**, follow the on-screen instructions to enter your payment details through Stripe, and then click **Save card**.
78+
![Unstructured account settings](/img/platform/AccountSettings.png)
79+
80+
![Unstructured account billing](/img/platform/AccountBilling.png)
81+
82+
1. Sign in to the Unstructured Platform.
83+
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
84+
3. On the account settings sidebar, click **Billing**.
85+
4. Click **Manage Payment Method**, follow the on-screen instructions to enter your payment details through Stripe, and then click **Save card**.
4586

4687
Your card is billed monthly based on your usage. The **Billing** page shows a billing overview for the current month and a list of your billing invoices.
4788

89+
<Note>
90+
You can always
91+
start a prepaid subscription in exchange for usage rate discounts. To switch your account from a pay-as-you-go plan to a prepaid subscription,
92+
contact Unstructured Sales at [[email protected]](mailto:[email protected]).
93+
</Note>
94+
4895
import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx';
4996

5097
<SharedPagesBilling />
5198

52-
<iframe
53-
width="560"
54-
height="315"
55-
src="https://www.youtube.com/embed/VyZqGxBMbnE"
56-
title="YouTube video player"
57-
frameborder="0"
58-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
59-
allowfullscreen
60-
></iframe>
61-
6299
## Quickstart
63100

64101
These examples use your local machine. They send source (input) files from your local machine to the Unstructured Serverless API which delivers the processed data to a destination (output) location, also on your local machine. Data is processed on Unstructured-hosted compute resources.
@@ -133,42 +170,32 @@ After the command successfully runs, see the results in the specified output pat
133170

134171
## Manage your account
135172

136-
**To manage your account**: Begin by going to [https://app.unstructured.io](https://app.unstructured.io) and signing in.
173+
**To manage your account**:
174+
175+
![Unstructured account settings](/img/platform/AccountSettings.png)
176+
177+
1. Sign in to the Unstructured Platform.
178+
2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**.
179+
180+
![Unstructured account settings sidebar](/img/platform/AccountSettingsSidebar.png)
137181

138182
**To manage your API keys**:
139183

140-
* On the sidebar, click **API Keys**.
184+
* On the account settings sidebar, click **API Keys**.
141185
* To create a key, click **Generate New Key**, and follow the on-screen instructions.
142186
* To enable or disable a key, switch **On/Off** in the column for that key to on or off.
143187
* To delete a key, click the trash can in the **Actions** column for that key.
144188

145-
**To view your usage**: On the sidebar, click **Usage**.
146-
147-
<iframe
148-
width="560"
149-
height="315"
150-
src="https://www.youtube.com/embed/VyZqGxBMbnE"
151-
title="YouTube video player"
152-
frameborder="0"
153-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
154-
allowfullscreen
155-
></iframe>
156-
157-
**To view your billing costs and invoices and to manage your payment method**: On the sidebar, click **Billing**.
158-
159-
<iframe
160-
width="560"
161-
height="315"
162-
src="https://www.youtube.com/embed/DPITllKgYvA"
163-
title="YouTube video player"
164-
frameborder="0"
165-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
166-
allowfullscreen
167-
></iframe>
168-
169-
**To log out of your account**: On the sidebar, click your email address, and then click **Logout**.
170-
171-
If you need direct assistance, our support team is just an email away. Contact us at [[email protected]](mailto:[email protected]).
189+
**To view your usage**: On the account settings sidebar, click **Usage**.
190+
191+
**To view your billing costs and invoices and to manage your payment method**: On the account settings sidebar, click **Billing**.
192+
193+
**To log out of your account**: On the account settings sidebar, click your email address, and then click **Logout**.
194+
195+
**To get help**: Our support team is just a text or email away:
196+
197+
* On the account settings sidebar, click **Message Us**, or...
198+
* Email us at [[email protected]](mailto:[email protected]).
172199

173200
## Telemetry
174201

img/platform/APIKeyURL.png

81.2 KB
Loading

img/platform/AccountBilling.png

73.8 KB
Loading

img/platform/AccountSettings.png

64.9 KB
Loading
19.9 KB
Loading
20.7 KB
Loading

img/platform/Job-Complete.png

-115 KB
Loading

img/platform/Job-Failed.png

4.01 KB
Loading
4.13 KB
Loading
4.08 KB
Loading

0 commit comments

Comments
 (0)