dodopayments/client

dev-main 2025-01-23 12:23 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.0
• phpdocumentor/reflection-docblock: ^5.4
• symfony/property-access: ^7.0
• symfony/property-info: ^7.0
• symfony/serializer: ^7.0

Requires (Dev)

• laravel/pint: ^1.13.7
• nyholm/psr7: ^1.8
• php-http/mock-client: ^1.6
• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^9

Apache-2.0

README

Welcome to the dodopayments SDK documentation. This guide will help you get started with integrating and using the dodopayments SDK in your project.

Versions

• API version: 0.19.0
• SDK version: 0.19.0

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
• Environments
  • Setting an Environment
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: PHP >= 8.0

Installation

To get started with the SDK, we recommend installing using composer:

composer require dodopayments/client

Authentication

Access Token Authentication

The dodopayments API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

new Client(accessToken: "YOUR_ACCESS_TOKEN");

If you need to set or update the access token after initializing the SDK, you can use:

sdk.setAccessToken("YOUR_ACCESS_TOKEN")

Environments

The SDK supports different environments for various stages of development and deployment.

Here are the available environments:

const Default = "https://live.dodopayments.com"
const LiveMode = "https://live.dodopayments.com"
const TestMode = "https://test.dodopayments.com"

Setting an Environment

To configure the SDK to use a specific environment, you can set the base URL as follows:

$sdk->setBaseUrl(Environment::live_mode);

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

$sdk = new Client(timeout: 1000);

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->checkout->getSupportedCountriesProxy();

print_r($response);

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:

License

This SDK is licensed under the Apache-2.0 License.

See the LICENSE file for more details.