Platform

Dashboard

Platform

Public health check and API key context (environment, actor, scopes).

Check API status

GET /v1/ping

Authorization: None

No authentication required.

Request body None

None

Response 2

data object

pong boolean

Example: 1

surface string

Enum

extern

version string

Example: v1

meta object

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Examples

GET /v1/ping

curl -X GET "https://api.appficient.nl/v1/ping" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/ping'
headers = {
    'Accept': 'application/json',
}

response = requests.get(url, headers=headers)
data = response.json()

const url = 'https://api.appficient.nl/v1/ping';
const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/ping';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request GET 'https://api.appficient.nl/v1/ping' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Get,
    "https://api.appficient.nl/v1/ping");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/ping"))
    .header("Accept", "application/json");

HttpRequest request = builder.GET().build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.appficient.nl/v1/ping", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/ping')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'

res = http.request(req)
data = JSON.parse(res.body)

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Curl, Node and response are shown to the right of this endpoint.

Test API connectivity

POST /v1/ping

Authorization: None

No authentication required.

Request body None

None

Response 2

data object

pong boolean

Example: 1

surface string

Enum

extern

version string

Example: v1

meta object

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Examples

POST /v1/ping

curl -X POST "https://api.appficient.nl/v1/ping" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/ping'
headers = {
    'Accept': 'application/json',
}

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

const url = 'https://api.appficient.nl/v1/ping';
const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/ping';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request POST 'https://api.appficient.nl/v1/ping' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Post,
    "https://api.appficient.nl/v1/ping");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/ping"))
    .header("Accept", "application/json");

HttpRequest request = builder
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://api.appficient.nl/v1/ping", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/ping')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req['Accept'] = 'application/json'

res = http.request(req)
data = JSON.parse(res.body)

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Curl, Node and response are shown to the right of this endpoint.

Retrieve API key details

GET /v1/me

Authorization: HTTP

name: httpBearer

type: http

scheme: bearer

Request body None

None

Response 2

data object

No env_id / actor.id in response.

surface string

Enum

extern

actor object

type string

On External `/v1` Bearer auth this is typically `api_key`.

Enum

api_key user link subscription_token none

label string

scopes array

meta object

{
    "data": {
        "surface": "extern",
        "actor": {
            "type": "api_key",
            "label": "string"
        },
        "scopes": [
            "string"
        ]
    },
    "meta": []
}

Examples

GET /v1/me

curl -X GET "https://api.appficient.nl/v1/me" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/me'
headers = {
    'Authorization': 'Bearer apf_xxxxxxxx',
    'Accept': 'application/json',
}

response = requests.get(url, headers=headers)
data = response.json()

const url = 'https://api.appficient.nl/v1/me';
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer apf_xxxxxxxx',
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/me';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer apf_xxxxxxxx',
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request GET 'https://api.appficient.nl/v1/me' \
  --header 'Authorization: Bearer apf_xxxxxxxx' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "apf_xxxxxxxx");
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Get,
    "https://api.appficient.nl/v1/me");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/me"))
    .header("Accept", "application/json")
    .header("Authorization", "Bearer apf_xxxxxxxx");

HttpRequest request = builder.GET().build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.appficient.nl/v1/me", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer apf_xxxxxxxx")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/me')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'
req['Authorization'] = 'Bearer apf_xxxxxxxx'

res = http.request(req)
data = JSON.parse(res.body)

{
    "data": {
        "surface": "extern",
        "actor": {
            "type": "api_key",
            "label": "string"
        },
        "scopes": [
            "string"
        ]
    },
    "meta": []
}

Curl, Node and response are shown to the right of this endpoint.

GET /v1/ping

curl -X GET "https://api.appficient.nl/v1/ping" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/ping'
headers = {
    'Accept': 'application/json',
}

response = requests.get(url, headers=headers)
data = response.json()

const url = 'https://api.appficient.nl/v1/ping';
const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/ping';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request GET 'https://api.appficient.nl/v1/ping' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Get,
    "https://api.appficient.nl/v1/ping");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/ping"))
    .header("Accept", "application/json");

HttpRequest request = builder.GET().build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.appficient.nl/v1/ping", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/ping')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'

res = http.request(req)
data = JSON.parse(res.body)

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

POST /v1/ping

curl -X POST "https://api.appficient.nl/v1/ping" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/ping'
headers = {
    'Accept': 'application/json',
}

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

const url = 'https://api.appficient.nl/v1/ping';
const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/ping';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request POST 'https://api.appficient.nl/v1/ping' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Post,
    "https://api.appficient.nl/v1/ping");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/ping"))
    .header("Accept", "application/json");

HttpRequest request = builder
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://api.appficient.nl/v1/ping", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/ping')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req['Accept'] = 'application/json'

res = http.request(req)
data = JSON.parse(res.body)

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

GET /v1/me

curl -X GET "https://api.appficient.nl/v1/me" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

import requests

url = 'https://api.appficient.nl/v1/me'
headers = {
    'Authorization': 'Bearer apf_xxxxxxxx',
    'Accept': 'application/json',
}

response = requests.get(url, headers=headers)
data = response.json()

const url = 'https://api.appficient.nl/v1/me';
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer apf_xxxxxxxx',
    Accept: 'application/json',
  },
};

const res = await fetch(url, options);
const json = await res.json();

<?php
$url = 'https://api.appficient.nl/v1/me';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer apf_xxxxxxxx',
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);

postman request GET 'https://api.appficient.nl/v1/me' \
  --header 'Authorization: Bearer apf_xxxxxxxx' \
  --header 'Accept: application/json'

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "apf_xxxxxxxx");
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

using var request = new HttpRequestMessage(
    HttpMethod.Get,
    "https://api.appficient.nl/v1/me");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://api.appficient.nl/v1/me"))
    .header("Accept", "application/json")
    .header("Authorization", "Bearer apf_xxxxxxxx");

HttpRequest request = builder.GET().build();

HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());
String json = response.body();

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.appficient.nl/v1/me", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer apf_xxxxxxxx")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(data))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.appficient.nl/v1/me')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'
req['Authorization'] = 'Bearer apf_xxxxxxxx'

res = http.request(req)
data = JSON.parse(res.body)

{
    "data": {
        "surface": "extern",
        "actor": {
            "type": "api_key",
            "label": "string"
        },
        "scopes": [
            "string"
        ]
    },
    "meta": []
}