Welcome to Dapi

Here you will find comprehensive documentation to help you integrate with Dapi's API as quickly as possible, as well as support if you get stuck. Get started below!

Get Started    

Using Postman

To test our API you might need API development software, such as Postman. Here's how to get started with Postman and Dapi.

1. Install Postman

Download the app from here.

Postman's download page

📘

Note

We will be using the Mac version for this tutorial, but the process should be similar across platforms.

2. Open the application

You may be prompted to log in or create an account. After you are finished with that step, you should see an interface similar to this:

Postman's default screen

3. Install Dapi's Postman environment and collection

  1. Download the Dapi sample Postman environment here
  2. Select the gear icon on the top right side of the screen.

Manage environments button

  1. Select "Import" on the bottom of the "Manage Environments" pop-up window.

Manage environments window

  1. Select the JSON file you downloaded (it should be called dapi-environment.json).

  2. Close the Manage Environments window.

  3. Download the Dapi sample Postman collection here.

  4. Select "Import" on the top left side of the screen.

Import Collections Button

  1. Upload the file you downloaded, which should be called dapi-api-collection.json

4. Add API Keys

To add credentials and other API keys you will refer back to the Dapi sample environment. Follow these steps:

  1. Select the gear icon on the top right corner of the screen.

Manage Environments Button

  1. Press the name of the "dapi - sample" environment, which should turn orange as you hover over it.

Environment Selection Screen

  1. Enter required values.

Environment Variable Input Screen

📘

Note

You can find required values by following steps in our Get Started guide here: Getting your API keys.

Use the "initial value" field for these parameters:

  • host
  • app_name
  • app_key
  • app_secret

Use the "current value" field for these parameters:

  • access_code
  • user_secret
  • connection_id
  • access_token
  • user_id

5. Run Requests

Now that you know how to input required key values, you're ready to run some requests.

  1. Expand the dapi-sample collection on the left side of the screen. You should see the following sub-folders:

dapi-sample Collection

  1. Expand the relevant folder to find specific endpoints. For this tutorial, we will use "Auth".
  2. Click on the relevant request, such as "Exchange Token".

Endpoint Selection

  1. Select "Body" in the central area of the screen. Your window should now look as follows:

ExchangeToken Body

Here you can see the following:

  1. Endpoint URL. The format should be set to "POST".

  2. Request body. It should already include all necessary variables in raw JSON format.

  3. The "Send" request button which you will use to push the requests.

  4. Ensure that you have typed in all the relevant fields from the request body into the environment. You can find out where to get the relevant information from our Get Started Guide.

  5. Press "Send".

  6. View request response. If successful, it should look as follows:

Successful ExchangeToken Response

📘

Note

For more information, see Making calls with Dapi's API.

Updated 16 days ago


Using Postman


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.