Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 1.85 KB

DetectAddressApi.md

File metadata and controls

63 lines (44 loc) · 1.85 KB

ClickSend\DetectAddressApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
detectAddressPost POST /post/letters/detect-address Detects address in uploaded file.

detectAddressPost

string detectAddressPost($body)

Detects address in uploaded file.

Detects address in uploaded file.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\DetectAddressApi(
    // 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(),
    $config
);
$body = new \ClickSend\Model\UploadFile(); // \ClickSend\Model\UploadFile | Your file to be uploaded

try {
    $result = $apiInstance->detectAddressPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DetectAddressApi->detectAddressPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ClickSend\Model\UploadFile Your file to be uploaded

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]