Undefined array key 0

[dietcheese]

Having a difficult time getting this working within Laravel.

Always getting a "Undefined array key 0" error. I am authenticating and getting an access token successfully.

Part of my class:

use Sugarcrm\REST\Client\SugarApi;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Log;

class SugarCRMService
{
    protected $client;
    protected $server;
    protected $credentials;

    public function __construct()
    {
        // Retrieve server URL and credentials from config (which pulls from .env)
        $this->server = Config::get('services.sugarcrm.url');
        $this->credentials = [
            'username'  => Config::get('services.sugarcrm.username'),
            'password'  => Config::get('services.sugarcrm.password'),
            'platform'  => Config::get('services.sugarcrm.platform'),
            'client_id' => Config::get('services.sugarcrm.client_id'),
        ];
        
        Log::info('Initializing SugarCRM Service', $this->credentials);
        
        try {
            // Instantiate the SugarApi client using the server URL and credentials.
            $this->client = new SugarApi($this->server, $this->credentials);
            
            // Check if the client is authenticated; if not, log in.
            if (!$this->client->isAuthenticated()) {
                $this->client->login();
            }
            
            // Log the token details (printing only the access_token for brevity)
            $token = $this->client->getAuth()->getToken();
            Log::info('Logged into SugarCRM', [
                'access_token' => $token->access_token,
                'expiration'   => $token->expiration,
            ]);
        } catch (\Exception $e) {
            Log::error('Failed to initialize SugarCRM client', [
                'message' => $e->getMessage(),
                'trace'   => $e->getTraceAsString(),
            ]);
            throw $e;
        }
    }

public function testAccount(string $accountId = 'be46e9f4-27e2-4357-9af4-b18039e1f231'): array
    {
        try {
            // Ensure the client is authenticated.
            if (!$this->client->isAuthenticated()) {
                $this->client->login();
            }
            
            // Build the custom endpoint URL.
            $endpoint = 'custom/account/' . $accountId;
            
            // Call the endpoint using the built-in get() method.
            $response = $this->client->get($endpoint);
            
            Log::info('Received response from testAccount', [
                'endpoint' => $endpoint,
                'response' => $response->toArray(),
            ]);
            
            return $response->toArray();
        } catch (\Exception $e) {
            Log::error('Failed testAccount call', [
                'endpoint' => 'custom/account/' . $accountId,
                'error'    => $e->getMessage(),
                'trace'    => $e->getTraceAsString(),
            ]);
            throw $e;
        }
    }
}

[2025-03-28 21:41:38] local.INFO: Logged into SugarCRM {"access_token":"12e9f4b1-c3bc-49e7-bf5b-f8114b62f8c0","expiration":1743500488} 
[2025-03-28 21:41:38] local.ERROR: Failed testAccount call {"endpoint":"custom/account/be46e9f4-27e2-4357-9af4-b18039e1f231","error":"Undefined array key 0","trace":"#0 
[2025-03-28 21:41:38] local.ERROR: Undefined array key 0 {"exception":"[object] (ErrorException(code: 0): Undefined array key 0 at /shared/httpd/test/htdocs/vendor/michaelj2324/php-rest-client/src/Endpoint/Provider/AbstractMultiVersionEndpointProvider.php:31)
[stacktrace]

It should be noted that when I use Guzzle instead, the same endpoint works fine:

         // Create a new Guzzle client.
            $guzzleClient = new GuzzleClient();
            
            // Make a GET request with the OAuth token set in headers.
            $response = $guzzleClient->request('GET', $url, [
                'headers' => [
                    'OAuth-Token' => $this->client->getAuth()->getToken()->access_token,
                ]
            ]);
            
            // Decode the response JSON.
            $data = json_decode($response->getBody()->getContents(), true);
            
            Log::info('Received response from testAccount (raw request)', [
                'url'  => $url,
                'data' => $data,
            ]);

[MichaelJ2324]

Hello,

So the reason for the failure is that the Guzzle Client separated from the SugarAPI Client object, doesn't have the necessary logic to always add the auth token on every request. The built in Auth Controller on the REST Client object, registers a function on the Guzzle HandlerStack for requests, but it relies on the Endpoint objects associated with the REST Client in order to know whether or not it should add the Auth headers to the request.

We have recently added a generic Rest endpoint function for easily working with custom Endpoints that fall outside the standard Sugar Endpoints, and so you don't have to pre-register your API Endpoints if you are working with something that needs to dynamically use custom endpoint URLS. THis is the PR: #12

This will allow you to do the following so your code can work:

// Instantiate the SugarApi client using the server URL and credentials.
$this->client = new SugarApi($this->server, $this->credentials);

// Check if the client is authenticated
// You don't have to call login, isAuthenticated handles all of that, even refresh auth
if ($this->client->isAuthenticated()) {
    $this->client->rest('custom/account/' . $accountId)->get();
}

Otherwise before this you needed to register your custom Endpoint on the Client such as:

$this->client->getEndpointProvider()->registerEndpoint('customEndpoint', \Sugarcrm\REST\Endpoint\Generic::class, [
    'httpMethod' => 'GET',
    'auth' => 1,
    'url' => 'custom/account/$id'
]);
$this->client->customEndpoint($accountId)->execute();