metatavu/metaform-api-client-php

metaform-api-client-php

REST API for Metaform, _(*1)

This PHP package is automatically generated by the Swagger Codegen project:, _(*2)

• API version: 0.0.1
• Package version: 0.1.1
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later, _(*3)

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:, _(*4)

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/metatavu/metaform-api-client-php.git"
    }
  ],
  "require": {
    "metatavu/metaform-api-client-php": "*@dev"
  }
}

Then run composer install, _(*5)

Manual Installation

Download the files and include autoload.php:, _(*6)

    require_once('/path/to/metaform-api-client-php/vendor/autoload.php');

Tests

To run the unit tests:, _(*7)

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:, _(*8)

setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Metatavu\Metaform\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Metatavu\Metaform\Api\AttachmentsApi();
$realmId = "realmId_example"; // string | realm id
$attachmentId = "attachmentId_example"; // string | Attachment id

try {
    $result = $api_instance->findAttachment($realmId, $attachmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentsApi->findAttachment: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost, _(*9)

Documentation For Models

• Attachment
• BadRequest
• EmailNotification
• ExportTheme
• ExportThemeFile
• Forbidden
• InternalServerError
• Metaform
• MetaformField
• MetaformFieldFlags
• MetaformFieldOption
• MetaformFieldPermissioncontexts
• MetaformFieldType
• MetaformSection
• MetaformTableColumn
• MetaformTableColumnType
• MetaformTableColumnValues
• MetaformVisibleIf
• NotFound
• NotImplemented
• Reply
• ReplyData
• ReplyExportFormat

Documentation For Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author