Proxy API API

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](https://tools.ietf.org/html/rfc7230) states header names are case insensitive. | Name | Type | Required | Description | | ---------------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Authorization | String | Yes | Bearer API KEY | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | x-apideck-consumer-id | String | Yes | The 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-url | String | Yes | Downstream URL to forward the request too | | x-apideck-downstream-authorization | String | No | Downstream authorization header. This will skip the Vault token injection. | | x-apideck-downstream-method | String | No | Downstream 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-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. | ## Authorization You can interact with the API through the authorization methods below. ### apiKey To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app. Your Apideck application_id can also be found on the same page. Authenticate your API requests by including your test or live secret API key in the request header. - Bearer authorization header: Authorization: Bearer <your-apideck-api-key> - Application id header: x-apideck-app-id: <your-apideck-app-id> 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 Type | HTTP | | ------------------------- | ------ | | HTTP Authorization Scheme | bearer | ### applicationId The ID of your Unify application | Security Scheme Type | API Key | | --------------------- | ---------------- | | Header parameter name | x-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 the Proxy API 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** - Other: upcoming More info about our data security can be found at [https://compliance.apideck.com/](https://compliance.apideck.com/) ## Limitations ### Timeout The request timeout is set at 30 seconds. ### Response Size The Proxy API has no response size limit. For responses larger than 2MB, the Proxy API will redirect to a temporary URL

Proxy API is a development API from apideck.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 5 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Development

Base URL

https://unify.apideck.com

Version

9.3.0

Endpoints

5

OpenAPI

Specification ↗

Spec updated

2023-04-19

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://unify.apideck.com/proxy" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://unify.apideck.com/proxy", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://unify.apideck.com/proxy",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions