Skip to content

pleiades-decom/php-api-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PLEIADES PHP API Client

Library for accessing PLEIADES API.

Requires PHP 7.4 and above.

Basic usage examples

$api = new \PleiadesDecom\PhpApiClient\Client([
  "clientId" => "", // your app's client ID
  "clientSecret" => "", // your app's client secret
  "userName" => "", // name of the user to authenticate
  "userPassword" => "", // password of the user to authenticate
  "iamTokenEndpoint" => "", // OIDC endpoint address of IAM server
  "apiEndpoint" => "", // API server endpoint address
]);
$api->getAccessToken();
$api->setDatabase("testDatabase");
$records = $api->getRecords(["class" => "Database.Information"]);

Working with records

Create record

$createdRecordId = $api->createRecord([
  "class" => "Any.Valid.Class.Name",
  "content" => ["AnyValidContent" => "AnyValidValue"]
]);

Update record

$api->updateRecord(
  $recordId,
  [
    "class" => "Any.Valid.Class.Name",
    "content" => ["AnyValidContent" => "AnyValidValue"]
  ]
);

Delete record

$api->deleteRecord($recordId);

Get single record

$record = $api->getRecord($recordId);

Get list of records

$records = $api->getRecords(["class" => "Any.Valid.Class.Name"]);

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages