Access the developer portal

The developer portal provides everything you need to discover, test, and consume APIs.

Log in to the portal

How you log in depends on whether your workspace uses Workato Identity:

• Log in with magic link: Your admin invites you by email and you access the portal using a link.
• Log in with Workato Identity: You log in using your Workato Identity credentials or through your organization's identity provider.

Log in with magic link

When an admin invites you to the developer portal, you receive an email with a link to access the portal.

Click the link provided in the invitation email and click Go to portal. The link is valid for 24 hours.

Invitation email

Enter your email address on the portal login page. Workato sends a new link to your inbox. The link is valid for 30 minutes.

Enter your email to request a new link

Log in with Workato Identity

Follow the Invited user tab if you received a portal invitation email. Follow the JIT user tab if your organization uses SSO with just-in-time (JIT) provisioning and you didn't receive an invitation.

Workato sends you a portal invitation email with a Go to portal link.

Complete the following steps to access the developer portal:

1

Click Go to portal in your portal invitation email.

2

Click Open portal.

3

Sign in with your Workato ID credentials, or through your organization's identity provider if SSO is configured.

On first login, you land on the Discover new APIs page, where you can browse available API collections and request access. On subsequent logins, you land on your My APIs page.

Your portal account is created automatically on first login if your organization uses SSO with JIT provisioning. You won't receive an email invitation — your admin will share the portal URL with you directly.

1

Go to the portal URL provided by your admin.

2

Enter your email address and authenticate through your organization's identity provider.

Your portal account is created automatically after authenticating. You land on the Discover new APIs page on first login, where you can browse available API collections and request access. On subsequent logins, you land on your My APIs page.

PORTAL ACCESS

Contact your admin for the portal URL and to confirm which access method applies to you.

Navigate the developer portal

After you log in, you can browse your assigned API collections, discover new ones, test endpoints, and manage your API keys.

• Browse API collections: View your assigned collections and explore endpoint documentation.
• Discover new APIs: Browse additional available collections and request access.
• Test endpoints: Send test requests to validate endpoint behavior.
• Manage and create API keys: Generate and manage keys for authenticating requests.

Browse API collections

You can access your assigned API collections in the My APIs tab. Selecting a collection opens its documentation, where you can explore endpoint methods, descriptions, and schemas. The documentation includes example requests and responses. You can also download the OpenAPI specifications.

Browse API collections

Discover new APIs

The Discover new APIs tab provides access to additional API collections. Browse collections to find APIs that match your needs, and request access directly through the portal.

Request access to new APIs

Complete the following steps to request access to new APIs:

1

Go to the Discover new APIs tab to browse available API collections.

Discover new APIs

2

Select the collection you plan to access and click Request access.

Request access to an API collection

3

Provide a reason for your request and click Send request. An admin reviews your request and determines whether to approve or reject it.

Request access

The requested APIs appear in your My APIs tab if your request is approved, granting you access to their endpoints and documentation.

Collection added to My APIs

Test endpoints

You can test API endpoints directly in the portal to validate their functionality. You must create an API key before testing if you don't already have one.

Complete the following steps to test an endpoint:

1

Go to your assigned collection in the My APIs tab and choose the endpoint you plan to test.

2

Click Try it out to open the testing interface.

Click Try it out

3

Click Execute to send a test request.

Click Execute

4

Review the response details, including status codes, headers, and payloads, to confirm the endpoint’s behavior.

Manage and create API keys

Use the Manage API keys page to create and manage your API keys. You can define security parameters such as allowed and blocked IP addresses.

Complete the following steps to create an API key:

1

Click your profile icon, then select Manage API keys in the drop-down menu.

Manage API keys

2

Click Create API key.

Create new API key

3

Enter a name in the API key name field.

Provide an API key name

4

Optional. Enter allowed IP addresses in the Allowed IPs field to restrict requests for enhanced security. To add multiple IP addresses, separate them using commas or define a range (106.226.100.3/20).

5

Optional. Enter blocked IP addresses in the Blocked IPs field to prevent requests from specific IP addresses. Blocked IPs take precedence over allowed IPs. Requests from an IP address are denied if it appears on both lists.

6

Click Generate to create the API key. Workato displays the generated token. Save this token securely, as it won’t display again. If you lose the token, you can refresh the key to generate a new one. Refreshing invalidates the existing token.

After creating the key, it appears on the Manage API keys page. You can use this page to view the token’s details or refresh, deactivate, or delete the key if required.