REST API v1: POST database profiles

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.

Als je een profiel wilt aanmaken, dien je een HTTP POST request te sturen naar de volgende URL.

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

De code $id moet je vervangen door de numerieke identifier of de naam van de database waar je het profiel in wilt opslaan. De veldwaardes van het profiel kun je in de body van het HTTP request plaatsen.

Zorg ervoor dat je hier een POST request stuurt en geen PUT request. Hoewel deze vaak niet verschillen zou je in dit geval een methode aanroepen om meerdere profielen te bewerken, zie meerdere profielen te bewerken.

Beschikbare parameters

Naast de parameters die zich al in de URL bevinden moeten er ook waarden voor het profiel meegegeven worden in de body van het POST verzoek. Vergeet vooral het e-mailadres niet mee te geven, zodat je het profiel straks met je emailcampagnes kunt bereiken.

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 naar je access token
$api = new CopernicaRestApi("your-access-token");

// veldwaarden voor het profiel
$data = array(
    'firstname' =>  'John',
    'lastname'  =>  'Doe',
    'email'     =>  'johndoe@example.com'
);

// voer het verzoek uit
$api->post("database/1234/profiles", $data);

// retourneer het ID van het aangemaakte profiel indien het verzoek succesvol uitgevoerd is

Dit voorbeeld vereist de REST API class.

Meer informatie