Check Balance API DocumentationCheck how many credits are remaining on the account linked to that API key.
Check Balance API Commands and Endpoint Details
Check how many credits are remaining on the account linked to that API key.
General Information
Cost per use | 0 credits |
Concurrent Connections | 1 If you need bulk data please use the website, it will be much faster. |
Expected Response Time | Almost instant |
API Endpoint
Use POST to send the data to servya.
Input Variables
Variable Name | Input Details |
---|---|
apikey | Your unique API Key. If you don't have one, please first get an API Key. |
job_type | check_balance |
Output Variables
Output Examples
{"credits":23140}
Servya API Instructions for Developers
To start testing your implementation and the provided code examples you will first need to acquire an API key.
When you have your API key you will want to visit the documentation for the individual tools to get the API endpoints, inputs, outputs and examples.
We have code examples in lots of popular languages but if you need some help in a different language you can get in touch for some advice.
The API uses simple HTTP post requests and JSON to keep the process of interacting with the API and handling the data returned as simple as possible.
See the list of tools on this page for a direct link to the documentation for the tools.
We have code examples for 6 major programming languages below to aid the integration with your platform.
How to use the API for End Users
Integrating Servya into a supported tool is really simple!
You will first need to get an API key for Servya and then copy it into your software.
From our side, that is all you need to do. Your software should now be able to use the data from our tools.
Servya API Code Examples
Below you'll find code examples in various programming languages. These examples demonstrate how to interact with our API, making it easier for you to integrate our services into your applications. Simply click on the headers to view the code in your preferred language and see how you can quickly get started.
<?php
$apiUrl = "https://api.servya.com/process_job.php";
$data = array(
'apikey' => '!! THIS IS WHERE YOU PUT YOUR API KEY !!',
'job_type' => 'check_balance'
);
$options = array(
'http' => array(
'header' => "Content-type: application/x-www-form-urlencoded\r\n",
'method' => 'POST',
'content' => http_build_query($data),
),
);
$context = stream_context_create($options);
$response = file_get_contents($apiUrl, false, $context);
if ($response === FALSE) {
die('Error');
}
$data = json_decode($response, true);
echo "Credits: " . $data['credits'];
?>
using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
class Program
{
private static readonly HttpClient client = new HttpClient();
static async Task Main()
{
// Input Variables
string api_key = "!! THIS IS WHERE YOU PUT YOUR API KEY !!";
var values = new Dictionary
{
{ "apikey", api_key },
{ "job_type", "check_balance" }
};
var content = new FormUrlEncodedContent(values);
var response = await client.PostAsync("https://api.servya.com/process_job.php", content);
var responseString = await response.Content.ReadAsStringAsync();
dynamic data = Newtonsoft.Json.JsonConvert.DeserializeObject(responseString);
// Output Response Data
Console.WriteLine("Credits: " + data.credits);
}
}
import requests
api_key = '!! THIS IS WHERE YOU PUT YOUR API KEY !!'
api_url = 'https://api.servya.com/process_job.php'
data = {
'apikey': api_key,
'job_type': 'check_balance'
}
response = requests.post(api_url, data=data)
data = response.json()
print("Credits:", data['credits'])
const https = require('https');
const querystring = require('querystring');
const postData = querystring.stringify({
'apikey': 'your_api_key',
'job_type': 'check_balance'
});
const options = {
hostname: 'api.servya.com',
port: 443,
path: '/process_job.php',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': postData.length
}
};
const req = https.request(options, (res) => {
let data = '';
res.on('data', (chunk) => {
data += chunk;
});
res.on('end', () => {
const parsedData = JSON.parse(data);
console.log("Credits:", parsedData.credits);
});
});
req.on('error', (e) => {
console.error(`Problem with request: ${e.message}`);
});
req.write(postData);
req.end();
require 'net/http'
require 'uri'
require 'json'
uri = URI.parse("https://api.servya.com/process_job.php")
request = Net::HTTP::Post.new(uri)
request.set_form_data(
"apikey" => "your_api_key",
"job_type" => "check_balance"
)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
data = JSON.parse(response.body)
puts "Credits: #{data['credits']}"
package main
import (
"bytes"
"fmt"
"net/http"
"net/url"
"strings"
)
func main() {
apiUrl := "https://api.servya.com/process_job.php"
data := url.Values{}
data.Set("apikey", "!! THIS IS WHERE YOU PUT YOUR API KEY !!")
data.Set("job_type", "check_balance")
req, err := http.NewRequest("POST", apiUrl, strings.NewReader(data.Encode()))
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
req.Header.Set("Content-Length", fmt.Sprint(len(data.Encode())))
client := &http.Client{}
response, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer response.Body.Close()
buf := new(bytes.Buffer)
buf.ReadFrom(response.Body)
fmt.Println("Response:", buf.String())
}
Tool Documentation
Get guidance on each specific API enabled tool and function here: