Cache POST Requests - API Caching Docs

Fetch and Cache Data

curl --request POST \
  --url https://sandbox.apicaching.io/ \
  --header 'Content-Type: application/json' \
  --header 'X-ApiCaching-ApiKey: <api-key>' \
  --header 'X-ApiCaching-OriginUrl: <x-apicaching-originurl>' \
  --data '{}'

import requests

url = "https://sandbox.apicaching.io/"

payload = {}
headers = {
    "X-ApiCaching-OriginUrl": "<x-apicaching-originurl>",
    "X-ApiCaching-ApiKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-ApiCaching-OriginUrl': '<x-apicaching-originurl>',
    'X-ApiCaching-ApiKey': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://sandbox.apicaching.io/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.apicaching.io/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ApiCaching-ApiKey: <api-key>",
    "X-ApiCaching-OriginUrl: <x-apicaching-originurl>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.apicaching.io/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ApiCaching-OriginUrl", "<x-apicaching-originurl>")
	req.Header.Add("X-ApiCaching-ApiKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.apicaching.io/")
  .header("X-ApiCaching-OriginUrl", "<x-apicaching-originurl>")
  .header("X-ApiCaching-ApiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.apicaching.io/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ApiCaching-OriginUrl"] = '<x-apicaching-originurl>'
request["X-ApiCaching-ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

POST

/

Fetch and Cache Data

curl --request POST \
  --url https://sandbox.apicaching.io/ \
  --header 'Content-Type: application/json' \
  --header 'X-ApiCaching-ApiKey: <api-key>' \
  --header 'X-ApiCaching-OriginUrl: <x-apicaching-originurl>' \
  --data '{}'

import requests

url = "https://sandbox.apicaching.io/"

payload = {}
headers = {
    "X-ApiCaching-OriginUrl": "<x-apicaching-originurl>",
    "X-ApiCaching-ApiKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-ApiCaching-OriginUrl': '<x-apicaching-originurl>',
    'X-ApiCaching-ApiKey': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://sandbox.apicaching.io/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.apicaching.io/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ApiCaching-ApiKey: <api-key>",
    "X-ApiCaching-OriginUrl: <x-apicaching-originurl>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.apicaching.io/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ApiCaching-OriginUrl", "<x-apicaching-originurl>")
	req.Header.Add("X-ApiCaching-ApiKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.apicaching.io/")
  .header("X-ApiCaching-OriginUrl", "<x-apicaching-originurl>")
  .header("X-ApiCaching-ApiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.apicaching.io/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ApiCaching-OriginUrl"] = '<x-apicaching-originurl>'
request["X-ApiCaching-ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

Authorizations

X-ApiCaching-ApiKey

string

header

required

Headers

X-ApiCaching-Endpoint

string

Your unique project endpoint. This is only required for this example. You should be accessing your unique endpoint directly, instead of the sandbox endpoint. If your endpoint is: https://my-special-endpoint.apicaching.io, set the value of this header to 'my-special-endpoint'.

X-ApiCaching-OriginUrl

string

required

Your origin API URL where you fetch your data from

X-ApiCaching-MaxAge

integer

default:86400

Max age for cache validity in seconds

X-ApiCaching-Swr

integer

default:0

Stale-while-revalidate period in seconds

Body

application/json

The body is of type object.

Response

Data fetched and cached successfully

The response is of type object.