Download the PHP package gando/partner without Composer

gando/partner

Developer-friendly & type-safe Php SDK specifically catered to leverage gando/partner API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Gando Partner API: API for rental management software and multi–rental-operator platforms integrating Gando on behalf of linked rental operators. Use gando_pk_ keys (x-api-key or Authorization: Bearer) on /api/partner/*.

Table of Contents

• gando/partner
  • SDK Installation
  • Two credentials, two classes
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Default retry policy
  • Retries
  • Error Handling
  • Server Selection
  • Webhook signature verification
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

Two credentials, two classes

Gando Partner integrations use two different secrets depending on what you are doing.

Example

PSR injection (enterprise/Symfony)

Gando\Partner\Api\Client accepts optional PSR interfaces so you can reuse your existing stack:

• PSR-18: Psr\Http\Client\ClientInterface
• PSR-17: Psr\Http\Message\RequestFactoryInterface
• PSR-3: Psr\Log\LoggerInterface
• PSR-16: Psr\SimpleCache\CacheInterface
• PSR-14: Psr\EventDispatcher\EventDispatcherInterface

All PSR dependencies are optional. If you omit httpClient and requestFactory, the SDK auto-discovers implementations through php-http/discovery (works out-of-the-box when guzzlehttp/guzzle v7 is installed).

Deposit create idempotency

POST /api/partner/deposits is idempotent when the Idempotency-Key header is sent (UUID v4, 24h deduplication via Redis on the API). Gando\Partner\Api\Client auto-generates that key on deposits->create() when you omit it, so SDK retries do not create duplicate deposits. Pass your own key to override.

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

You can set the security parameters through the setSecurity function on the SDKBuilder when initializing the SDK. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

Available Resources and Operations

Default retry policy

All Partner API operations use the global x-speakeasy-retries extension from the Partner OpenAPI document (PARTNER_SPEAKEASY_RETRIES in gando-app → lib/api/openapi/shared.ts). Out of the box, the SDK retries transient failures without custom loops in partner integrations.

The SDK respects a Retry-After response header when present. Override globally via Gando::builder()->setRetryConfig(...) or per call via Utils\Options (see below).

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide an Options object built with a RetryConfig object to the call:

If you'd like to override the default retry strategy for all operations that support retries, you can pass a RetryConfig object to the SDKBuilder->setRetryConfig function when initializing the SDK:

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a Errors\APIException exception, which has the following properties:

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list method throws the following exceptions:

Example

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

Webhook signature verification

Inbound partner webhooks are signed by Gando. Verify every delivery before processing the JSON payload.

Headers: X-Gando-Signature (sha256=<hex>), X-Gando-Timestamp (Unix seconds), X-Gando-Event (event name).

Use the raw request body (not json_decode output). The signing secret is returned once when you create a webhook endpoint (gando_whsec_...).

See also Webhooks SDK docs and the recipe snippet at recipes/snippets/webhooks.verify.php.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy