COD (contrassegni)

Elenco dei contrassegni incassati

Cod

Questo endpoint permette di ottenere l'elenco dei contrassegni incassati.

GET https://api.gsped.it/[ISTANZA]/Cod

Query parameters

Name	Type	Description
client_id*	int	ID del cliente (o del cliente fatturato)
days	int	Recupera contrassegni pagati negli ultimi X giorni (minimo 1, massimo 90, default 10)

Headers

Name	Type	Description
x-api-key*	string	API key fornita da Gsped

200: OK elenco contrassegni

{
    "status": 200,
    "response": [
        {...},
        {...},
    ]
}

400: Bad Request Errore input

{
  "status": 400,
  "errors": [
    "client_id obbligatorio"
  ],
  "response": []
}

403: Forbidden Apikey invalida

{
  "status": false,
  "error": "Invalid API key "
}

Snippets codice di esempio

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gsped.it/sandbox/Cod?client_id=123",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => [
    "x-api-key: YOUR-API-KEY"
  ],
]);

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

curl_close($curl);

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

PYTHON

import http.client

conn = http.client.HTTPSConnection("api.gsped.it")

payload = ""

headers = { 'x-api-key': "YOUR-API-KEY" }

conn.request("GET", "/sandbox/Cod?client_id=123", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

GO

package main

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

func main() {

	url := "https://api.gsped.it/sandbox/Cod?client_id=123"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "YOUR-API-KEY")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

C#

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.gsped.it/sandbox/Cod?client_id=123"),
    Headers =
    {
        { "x-api-key", "YOUR-API-KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

cURL

curl --request GET \
  --url 'https://api.gsped.it/sandbox/Cod?client_id=123' \
  --header 'x-api-key: YOUR-API-KEY'