OpenAPIClient-php

API documentation for api.adres-validatie.nl

Installation & Usage

Requirements

PHP 7.4 and later. Also works with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "require": {
    "adres-validatie-nl/php-sdk": "^1.3.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new OpenAPI\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$client_id = 'client_id_example'; // string | The account's client id
$client_secret = 'client_secret_example'; // string | The account's client secret

try {
    $result = $apiInstance->accessTokenPost($client_id, $client_secret);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->accessTokenPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.adres-validatie.nl

Class	Method	HTTP request	Description
DefaultApi	accessTokenPost	POST /access-token
DefaultApi	accountPost	POST /account
DefaultApi	accountWebhookPut	PUT /account/webhook
DefaultApi	fileAddressesCsvGet	GET /file/addresses.csv
DefaultApi	fileAddressesZipGet	GET /file/addresses.zip
DefaultApi	stripeCheckoutSessionPost	POST /stripe/checkout/session
DefaultApi	stripePortalSessionPost	POST /stripe/portal/session

Models

• AccessTokenPost200Response
• AccountPost200Response
• AccountPost201Response
• AccountPost201ResponseAccount
• AccountPost400Response
• AccountPost500Response
• AccountWebhookPut200Response
• AccountWebhookPut200ResponseAccount
• AccountWebhookPut401Response
• AccountWebhookPut500Response
• FileAddressesCsvGet200Response
• FileAddressesCsvGet402Response
• FileAddressesZipGet200Response
• StripeCheckoutSessionPost200Response
• StripePortalSessionPost200Response

Authorization

Authentication schemes defined for the API:

Oauth2

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes:
  • read:data: Read data from the API
  • write:data: Write data to the API

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
  • Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen