English | Español | Português Brasileiro
Cliente PHP para as APIs GraphQL e REST do Thoth.
Documentação da API: https://api.thoth.pub/graphiql
$client = new \ThothApi\GraphQL\Client();O cliente mapeia todas as consultas da API GraphQL do Thoth. Os métodos retornam dados no formato orientado a objetos, facilitando o uso e manipulação das informações.
$contributors = $client->contributors();
echo print_r($contributors, true);
/**
* Array (
* [0] => ThothApi\GraphQL\Models\Contributor Object (
* [data] => Array (
* [contributorId] => e1de541c-e84b-4092-941f-dab9b5dac865
* [firstName] => Aaron
* [lastName] => Ansell
* [fullName] => Aaron Ansell
* [orcid] => https://orcid.org/0000-0001-6365-5168
* [website] =>
* )
* )
* [1] => ThothApi\GraphQL\Models\Contributor Object (
* [data] => Array (
* [contributorId] => 1c3aade6-6d48-41b4-8def-b435f4b43573
* [firstName] => Aaron D.
* [lastName] => Hornkohl
* [fullName] => Aaron D. Hornkohl
* [orcid] =>
* [website] => https://www.ames.cam.ac.uk/people/dr-aaron-d-hornkohl
* )
* )
* ...
* )
*/
$contributor = array_shift($contributors);
echo $contributor->getLastName(); // Ansell
echo $contributor->getOrcid(); // https://orcid.org/0000-0001-6365-5168As consultas podem aceitar um array com os argumentos necessários, conforme especificado no esquema GraphQL da Thoth. É possível utilizar o argumento "order" especificando apenas o campo e a direção desejada.
$works = $client->works([
'publishers' => ['71faf1c3-900a-4b8c-bca7-4f927699fb90'],
'limit' => 5,
'field' => 'PUBLICATION_DATE',
'direction' => 'DESC'
]);Para executar mutações é necessário realizar a autenticação com as credenciais de uma conta Thoth.
$client->login($email, $password);Mutações podem ser executadas fornecendo uma instância da classe modelo correspondente ao tipo da mutação. Para mutações de exclusão, é necessário apenas fornecer o ID do objeto. Quando a operação é bem-sucedida, o ID do objeto é retornado.
use ThothApi\GraphQL\Models\Subject;
$subject = new Subject();
$subject->setWorkId('5a5b0fe3-03a9-444b-b221-ecae5370ff30');
$subject->setSubjectType(Subject::SUBJECT_TYPE_BIC);
$subject->setSubjectCode('1D');
$subject->setSubjectOrdinal(3);
$subjectId = $client->createSubject($subject); // 1d5ae47b-9e0c-4fba-b2d4-a3a2cdd8860c
$client->deleteSubject($subjectId);Uma exceção do tipo QueryException é lançada em caso de erro na solicitação à API GraphQL. É possível recuperar a mensagem do erro e uma descrição mais detalhada a partir da exceção.
try {
$work = new \ThothApi\GraphQL\Models\Work([
'fullTitle' => 'Foo Bar',
'title' => 'Foo',
]);
$workId = $client->createWork($work);
} catch (\ThothApi\Exception\QueryException $exception) {
echo $exception->getMessage();
/**
* Invalid value for argument "data", reason:
* "NewWork" is missing fields: "imprintId", "workStatus", "workType"
*/
echo print_r($exception->getDetails());
/**
* Array (
* [message] => Invalid value for argument "data", reason: "NewWork" is missing fields: "imprintId", "workStatus", "workType"
* [locations] => Array (
* [0] => Array (
* [line] => 3
* [column] => 15
* )
* )
* )
*/
}Documentação da API: https://export.thoth.pub/
$client = new \ThothApi\Rest\Client();
echo(print_r($client->work('doideposit::crossref', 'e0f748b2-984f-45cc-8b9e-13989c31dda4'), true));
/**
* <?xml version="1.0" encoding="utf-8"?>
* <doi_batch version="5.3.1" xmlns="http://www.crossref.org/schema/5.3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.crossref.org/schema/5.3.1 http://www.crossref.org/schemas/crossref5.3.1.xsd" xmlns:ai="http://www.crossref.org/AccessIndicators.xsd" xmlns:jats="http://www.ncbi.nlm.nih.gov/JATS1" xmlns:fr="http://www.crossref.org/fundref.xsd">
* <head>
* <doi_batch_id>e0f748b2-984f-45cc-8b9e-13989c31dda4_20241010195624</doi_batch_id>
* <timestamp>20241010195624</timestamp>
* <depositor>
* <depositor_name>Thoth</depositor_name>
* <email_address>distribution@thoth.pub</email_address>
* </depositor>
* <registrant>Thoth</registrant>
* </head>
* <body>
* <book book_type="monograph">
* <book_metadata language="en">
* <contributors>
* <person_name sequence="first" contributor_role="author">
* <given_name>Ammiel</given_name>
* <surname>Alcalay</surname>
* <affiliations>
* <institution>
* <institution_name>Queens College, CUNY</institution_name>
* <institution_id type="ror">https://ror.org/03v8adn41</institution_id>
* </institution>
* <institution>
* <institution_name>The Graduate Center, CUNY</institution_name>
* <institution_id type="ror">https://ror.org/00awd9g61</institution_id>
* </institution>
* </affiliations>
* </person_name>
* </contributors>
* <titles>
* <title>A Bibliography for After Jews and Arabs</title>
* </titles>
* ...
*/try {
$result = $client->publisher('foo', '42b3315e-07e9-4e23-92ae-86932e4ef0e3');
} catch (\ThothApi\Exception\RestException $exception) {
echo $exception->getMessage(); // "foo is not a valid metadata specification"
}O construtor de ambos os Clientes pode receber um array opcional para adicionar configurações personalizadas de solicitação do Cliente HTTP Guzzle.
$client = new Client([
'allow_redirects' => false,
'connect_timeout' => 3.14,
'timeout' => 3.14
'proxy' => [
'http' => 'http://localhost:8125', // Use this proxy with "http"
'https' => 'http://localhost:9124', // Use this proxy with "https",
'no' => ['.mit.edu', 'foo.com'] // Don't use a proxy with these
],
'debug' => true
...
]);Os clientes fazem requisições para os endereços padrão das APIs Thoth: https://api.thoth.pub/ para a API GraphQL e https://export.thoth.pub/ para a API REST. Se você deseja utilizar um endereço diferente (como "localhost" para testes), basta adicionar a opção "base_uri" com o novo endereço no construtor do cliente.
$client = new Client(['base_uri' => 'localhost:8000']);Idealizado e patrocinado por Thoth.
Desenvolvido por Lepidus Tecnologia.
Licenciado sob a Licença Apache, Versão 2.0 - Veja o arquivo de licença.
Copyright (c) 2024 Lepidus Tecnologia
Copyright (c) 2024 Thoth