Apideck

Proxy API

Welcome to the Proxy API. You can use this API to access all Proxy API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Proxy API.

You can use this API to access all Proxy API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

NameTypeRequiredDescription
AuthorizationStringYesBearer KEY
x-apideck-app-idStringYesThe application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
x-apideck-consumer-idStringYesThe id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-downstream-urlStringYesDownstream URL to forward the request too
x-apideck-downstream-authorizationStringNoDownstream authorization header. This will skip the Vault token injection.
x-apideck-downstream-methodStringNoDownstream method. If not provided the upstream method will be inherited, depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
x-apideck-service-idStringNoDescribe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-timeoutIntegerNoOverride the default downstream request timeout in milliseconds. Default is 28000 (28 seconds).

Query parameters must be included in the x-apideck-downstream-url header. The request URL's own query string is not forwarded downstream: it is ignored.

Authorization

You can interact with the API through the authorization methods below.

API Key

To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page.

Authenticate your API requests by including your test or live secret API key in the request header.

  • Bearer header: Authorization: Bearer "YOUR_API_KEY_HERE"
  • Application id header: x-apideck-app-id: "YOUR_APP_ID_HERE"

You should use the public keys on the SDKs and the secret keys to authenticate API requests.

Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.

Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key

Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

Security Scheme TypeHTTP
HTTP Authorization Schemebearer

applicationId

The ID of your Unify application

Security Scheme TypeAPI Key
Header parameter namex-apideck-app-id

Static IP

Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.
To use this feature, the API Vendor will need to whitelist the associated static IP addresses.
The provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.

  • EU Central 1: 18.197.244.247, 18.156.9.3, 3.65.139.215
  • Other: upcoming

More info about our data security can be found at https://compliance.apideck.com/

Limitations

Timeout

The default downstream request timeout is 28 seconds. You can override this per request by passing the x-apideck-timeout header with a value in milliseconds.

Response Size

The Proxy API has no response size limit. For responses larger than 2MB, the Proxy API will redirect to a temporary URL. In this case the usual Apideck response headers will be returned in the redirect response. Most HTTP clients will handle this redirect automatically.

GET /proxy
 '`

#### ConnectorCredentialsError

A request using a given connector has not been…

Endpoints 6

Execute

  • GETGET/proxyProxies a downstream GET request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…
  • PUTPUT/proxyProxies a downstream PUT request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…
  • POSTPOST/proxyProxies a downstream POST request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…
  • DELETEDELETE/proxyProxies a downstream DELETE request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…
  • OPTIONSOPTIONS/proxyProxies a downstream OPTION request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…
  • PATCHPATCH/proxyProxies a downstream PATCH request to a service and injects the necessary credentials into a request stored in Vault. This allows you to have an additional…

API details

Base URL
https://unify.apideck.com
Authentication
An API key in the Authorization header
An API key in the x-apideck-app-id header
Operations
6 operations on 1 pathGET 1PUT 1POST 1PATCH 1DELETE 1OPTIONS 1
Main resources
Execute 6
Description format
OpenAPI 3.0.3, API version 10.83.0

How to test the Proxy API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Proxy API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “GET” (GET /proxy), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Proxy API?

Welcome to the Proxy API. You can use this API to access all Proxy API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com… It is listed under Developer tools and has 6 endpoints.

Who publishes the Proxy API?

It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Proxy API?

Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.

How do I authenticate with the Proxy API?

It accepts 2 methods: an API key in the Authorization header; an API key in the x-apideck-app-id header.

How many endpoints does the Proxy API have?

6 operations on 1 path (1 GET, 1 PUT, 1 POST, 1 PATCH, 1 DELETE, 1 OPTIONS). The largest groups are Execute.

Is forking the Proxy API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.