REST API v1: GET collection

Waarschuwing: Je bekijkt nu het overzicht voor de oude versie van onze API. Wij raden aan om onze laastste versie van de API te gebruiken.

Een collectie is een "tweede laag" binnen een database. Als je de numerieke identifier van een collectie weet, dan kun je met een HTTP GET request de gegevens van de collectie ophalen:

https://api.copernica.com/v1/collection/$id?access_token=xxxx

Als $id moet je de numerieke identifier van de collectie opgeven.

Geretourneerde velden

Variabele Omschrijving
id Unieke numerieke identifier
name Naam van de collectie
database id van de database waartoe de collectie behoort
fields Array met de velden in de collectie

De velden worden teruggegeven als arrays van objecten. Als je wilt weten hoe deze arrays zijn opgebouwd kun je een blik werpen op de documentatie over het opvragen van velden in een collectie.

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je de API methode kunt aanroepen:

// vereiste scripts
require_once('copernica_rest_api.php');

// verander dit in je access code access token
$api = new CopernicaRestApi("your-access-token");

// voer de opdracht uit en print het resultaat
print_r($api->get("collection/1234"));

Dit voorbeeld vereist de REST API class.

Meer informatie