The File Picker arrived!Read the announcement

Search docs

Get Started

This guide will get you up and running with Apideck. To get started on our platform, you need to:

After completing these steps, you can make API calls to our Unified APIs 🎉

Step 1: Create an account

If you haven't already, head over to our Signup page and create an account. Choose an application name and a subdomain. Afterward, you will be redirected to the Apideck dashboard.

Step 2: Enable Unified APIs and connectors

Go to the Unified APIs page in the Apideck dashboard. Choose one or more Unified APIs to enable. You'll see a list of the available connectors for each Unified API. Choose a couple of connectors to enable. The Unified APIs and connectors you select become available to your users in Vault.

OAuth Apps

By default, all connectors use sandbox OAuth apps from Apideck. This makes it easy for you to get started and connect integrations right away.

However, once you're ready to ship your integrations with Apideck, you should publish your own OAuth apps for every connector. This will make sure your users see your brand instead of Apideck when they connect integrations.

Step 3: Authorize connectors

To authorize connectors, we'll use Apideck Vault. Vault lets your users connect their integration accounts. It stores the credentials securely and lets you make authorized API calls on your users' behalf.

Apideck Vault diagram
Apideck Vault diagram

In Apideck, a consumer refers to your end-user. When a consumer authorizes an integration, their credentials are stored in a connection. Connections are specific to a Unified API and a Connector (for example, CRM - Hubspot).

To get started, we'll use Vault as a dummy consumer. Head over to the Vault page in the Apideck dashboard and generate a test session. This will launch our Hosted Vault app with a dummy consumer.

Go to the Integrations page in Vault. Search for a connector that you enabled in the previous step, add the integration, and press Authorize. You will be redirected to the connector and asked to authorize Apideck. After you complete this flow, you will be redirected back to Hosted Vault, and the connector is now authorized.

All that's left now is to grab your API key and make your first call 🎉

Step 4: Get your API key

Go to the API Keys page in the Apideck dashboard. Copy your application ID and API key. If your API key ever gets compromised, you can regenerate it on this page.

First API call

You now have all the building blocks to make your first call to the Apideck API. Here's an example curl to the CRM API to get you started.

curl --request GET \
  --url 'https://unify.apideck.com/crm/companies' \
  --header 'Authorization: Bearer {API_KEY}' \
  --header 'x-apideck-app-id: {APP_ID}' \
  --header 'x-apideck-consumer-id: test-consumer' \
  --header 'x-apideck-service-id: {SERVICE_ID}'
  • {APP_ID} and {API_KEY} are the values you copied in step 4.
  • {SERVICE_ID} is the Connector ID you want to make a request to. This ID is the name of the connector in kebab-case (for example google-drive). Find the full list of connector IDs here.
  • test-consumer is the consumer ID that Hosted Vault uses for test sessions. The connector we authorized earlier is linked to this consumer. When you're using Apideck with real users, you should use a unique user identifier as consumer ID.

SDKs

Our Node.js SDK is the easiest way to integrate our API into your codebase. Find out how to get started with it here. SDKs for other popular languages such as Python and Java are coming soon.

API Tools

The Apideck API Explorer is a great way to explore our APIs through a UI. We also offer integrations with Postman and Insomnia. Head over to one of our API references and use the Actions dropdown to use these tools.

The OpenAPI specifications for all of our APIs are open source.

GraphQL

All of our APIs are also available in GraphQL. Read up on our schema and make your first queries in the GraphQL playground.

Samples

Looking for inspiration? Take a look at our sample projects. All of our samples are completely open-source.